Entrust Identity Verification

https://documentation.identity.entrust.com/
Admin
Entrust Identity Verification Platform enables secure customer onboarding with document and...
Tokens:362,604
Snippets:4,076
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Configure and Start Onfido SDK

Source: https://documentation.identity.entrust.com/sdk/react-native

Full implementation example showing how to import the SDK, configure it with a token and workflow ID, and handle success or error callbacks within a React Native component.

```javascript
import React, {Component} from 'react';
import {Button, View} from 'react-native';
import {
  Onfido,
  OnfidoCaptureType,
  OnfidoCountryCode,
  OnfidoDocumentType,
} from '@onfido/react-native-sdk';

export default class App extends Component {
  startSDK() {
    Onfido.start({
      sdkToken: "<YOUR_SDK_TOKEN>",
      workflowRunId: "<YOUR_WORKFLOW_RUN_ID>",
    })
      .then(res => console.warn('OnfidoSDK: Success:', JSON.stringify(res)))
      .catch(err => console.warn('OnfidoSDK: Error:', err.code, err.message));
  }

  render() {
    return (
      <View style={{marginTop: 100}}>
        <Button title="Start Onfido SDK" onPress={() => this.startSDK()} />
      </View>
    );
  }
}
```

--------------------------------

### Install iOS Pods

Source: https://documentation.identity.entrust.com/sdk/react-native/15.2.0

Navigate to the ios directory and install dependencies.

```bash
cd ios
pod install
cd ..
```

--------------------------------

### Start Onfido Workflow

Source: https://documentation.identity.entrust.com/sdk/android/23.4.0

Create the workflow instance and launch the intent to start the flow.

```kotlin
1onfidoWorkflow = OnfidoWorkflow.create(this)
2startActivityForResult(onfidoWorkflow.createIntent(workflowConfig), REQUEST_CODE)
```

--------------------------------

### API Token Authentication Examples

Source: https://documentation.identity.entrust.com/api/3.2.0

Examples demonstrating how to authenticate API requests using API tokens across various programming languages and HTTP.

```http
curl -H "Authorization: Bearer YOUR_API_TOKEN" https://api.eu.onfido.com/v3/reports
```

```bash
export ONFIDO_API_TOKEN='YOUR_API_TOKEN'
curl -H "Authorization: Bearer $ONFIDO_API_TOKEN" https://api.eu.onfido.com/v3/reports
```

```javascript
const axios = require('axios');

const apiToken = 'YOUR_API_TOKEN';
const reportsUrl = 'https://api.eu.onfido.com/v3/reports';

axios.get(reportsUrl, {
  headers: {
    'Authorization': `Bearer ${apiToken}`
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching reports:', error);
});
```

```python
import requests

api_token = 'YOUR_API_TOKEN'
reports_url = 'https://api.eu.onfido.com/v3/reports'

headers = {
    'Authorization': f'Bearer {api_token}'
}

response = requests.get(reports_url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f'Error: {response.status_code}, {response.text}')
```

```java
import okhttp3.*;
import java.io.IOException;

public class ApiRequest {
    public static void main(String[] args) throws IOException {
        String apiToken = "YOUR_API_TOKEN";
        String reportsUrl = "https://api.eu.onfido.com/v3/reports";

        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url(reportsUrl)
            .header("Authorization", "Bearer " + apiToken)
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Error: " + response.code() + ", " + response.body().string());
            }
        }
    }
}
```

```php
<?php

$apiToken = 'YOUR_API_TOKEN';
$reportsUrl = 'https://api.eu.onfido.com/v3/reports';

$headers = [
    'Authorization: Bearer ' . $apiToken
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $reportsUrl);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>
```

```ruby
require 'httparty'

api_token = 'YOUR_API_TOKEN'
reports_url = 'https://api.eu.onfido.com/v3/reports'

response = HTTParty.get(reports_url, headers: { 'Authorization' => "Bearer #{api_token}" })

if response.success?
  puts response.body
else
  puts "Error: #{response.code}, #{response.body}"
end
```

--------------------------------

### Retrieve document object example

Source: https://documentation.identity.entrust.com/api/3.2.0

Example response showing the structure of a document object after creation.

```json
1HTTP/1.1 201 Created
2
3
4{
5  "id": "<DOCUMENT_ID>",
6  "created_at": "2019-02-11T13:49:20Z",
7  "file_name": "sample_driving_licence.png",
8  "file_type": "png",
9  "file_size": 490408,
10  "type": "driving_licence",
11  "side": "front",
12  "issuing_country": null,
13  "applicant_id": "<APPLICANT_ID>",
14  "href": "/v3.2/documents/<DOCUMENT_ID>",
15  "download_href": "/v3.2/documents/<DOCUMENT_ID>/download"
16}
```

--------------------------------

### Android Onfido Config Example

Source: https://documentation.identity.entrust.com/sdk/sdk-migration-guide-2025

Example of building an Onfido configuration with a specified locale for the Android SDK.

```kotlin
1final OnfidoConfig config = OnfidoConfig.builder()
2  .withLocale(fr)
3  .build();
```

--------------------------------

### Start Onfido SDK Flow

Source: https://documentation.identity.entrust.com/sdk/react-native/15.2.0

Launches the Onfido SDK with a given configuration object. Ensure to listen for the result after the SDK is started.

```javascript
1Onfido.start(config);
2// listen for the result

```

--------------------------------

### Example Signing Document Object

Source: https://documentation.identity.entrust.com/api/latest

This example shows the structure of a signing document object, including its ID, creation timestamp, file details, and download URI.

```json
{
  "id": "<SIGNING_DOCUMENT_ID>",
  "created_at": "2019-10-09T16:59:06Z",
  "file_name": "<FILE_NAME>.png",
  "file_type": "pdf",
  "file_size": 536630,
  "href": "/v3.6/signing_documents/<SIGNING_DOCUMENT_ID>",
  "download_href": "/v3.6/signing_documents/<SIGNING_DOCUMENT_ID>/download"
}
```

--------------------------------

### Complete Onfido SDK Configuration Example

Source: https://documentation.identity.entrust.com/sdk/react-native/15.2.0

An example of a comprehensive configuration for the Onfido SDK, including necessary imports and event handling for success and errors. This is typically used within a React Native component.

```javascript
1import React, {Component} from 'react';
2import {Button, View} from 'react-native';
3import {
4  Onfido,
5  OnfidoCaptureType,
6  OnfidoCountryCode,
7  OnfidoDocumentType,
8} from '@onfido/react-native-sdk';
9
10export default class App extends Component {
11  startSDK() {
12    Onfido.start({
13      sdkToken: "<YOUR_SDK_TOKEN>",
14      workflowRunId: "<YOUR_WORKFLOW_RUN_ID>",
15    })
16      .then(res => console.warn('OnfidoSDK: Success:', JSON.stringify(res)))
17      .catch(err => console.warn('OnfidoSDK: Error:', err.code, err.message));
18  }
19
20  render() {
21    return (
22      <View style={{marginTop: 100}}>
23        <Button title="Start Onfido SDK" onPress={() => this.startSDK()} />
24      </View>
25    );
26  }
27}

```

--------------------------------

### Install Onfido SDK via Yarn

Source: https://documentation.identity.entrust.com/sdk/web/14.62.0

Install the Onfido Web SDK using Yarn. From version 14 onwards, the package defaults to connecting to the Onfido CDN.

```bash
yarn add onfido-sdk-ui
```

--------------------------------

### Install Onfido SDK via NPM

Source: https://documentation.identity.entrust.com/sdk/web/14.62.0

Install the Onfido Web SDK using NPM. From version 14 onwards, the package defaults to connecting to the Onfido CDN.

```bash
npm install onfido-sdk-ui
```

--------------------------------

### GET /v3.6/workflow_runs/{workflow_run_id}/tasks

Source: https://documentation.identity.entrust.com/api/latest

Retrieves a list of tasks associated with a specific workflow run. Returns a subset of the Task object for tasks that have started or completed.

```APIDOC
## GET /v3.6/workflow_runs/{workflow_run_id}/tasks

### Description
Retrieves the Tasks of a Workflow Run. Returns a subset of the Task object. The response contains only Tasks that were already started or completed, ordered by the created_at field, in ascending order.

### Method
GET

### Endpoint
/v3.6/workflow_runs/{workflow_run_id}/tasks

### Parameters
#### Path Parameters
- **workflow_run_id** (string) - Required - The unique identifier of the Workflow Run to which the Tasks belong.

### Response
#### Success Response (200)
- **id** (string) - The identifier for the Task.
- **task_def_id** (string) - The identifier for the Task Definition.
- **workflow_run_id** (string) - The identifier for the Workflow Run.
- **created_at** (datetime) - The date and time when the Task was created.
- **updated_at** (datetime) - The date and time when the Task was last updated.

#### Response Example
[
  {
    "id": "<TASK_ID>",
    "task_def_id": "<TASK_DEF_ID>",
    "workflow_run_id": "<WORKFLOW_RUN_ID>",
    "created_at": "2022-06-28T15:39:42Z",
    "updated_at": "2022-07-28T15:39:52Z"
  }
]
```

--------------------------------

### Configure Welcome Step

Source: https://documentation.identity.entrust.com/sdk/ios/32.6.2

Add the welcome screen to the SDK configuration using the builder pattern.

```swift
let config = try OnfidoConfig.builder()
    .withWelcomeStep()
    ...
    .build()
```

```objc
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder];
[configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"];
...
[configBuilder withWelcomeStep];

NSError *configError = NULL;
ONFlowConfig *config = [configBuilder buildAndReturnError:&configError];

if (configError) {
    // Handle config build error
} else {
    // use config
}
```

--------------------------------

### Example Workflow Task Started Event Payload

Source: https://documentation.identity.entrust.com/api/latest

This JSON object shows the payload for a 'workflow_task.started' webhook event. It indicates that a specific task within a workflow run has begun execution.

```json
HTTP/1.1 201 Created


{
  "payload": {
    "resource_type": "workflow_task",
    "action": "workflow_task.started",
    "object": {
      "id": "document_photo_c0888",
      "task_spec_id": "document_photo_c0888",
      "task_def_id": "upload_document_photo",
      "workflow_run_id": "0072fd81-7c5f-4bff-b3a9-7bea6ec3f838",
      "status": "started",
      "started_at_iso8601": "2022-12-19T16:44:54Z",
      "href": "https://api.onfido.com/v3.6/workflow_runs/0072fd81-7c5f-4bff-b3a9-7bea6ec3f838/tasks/document_photo_c0888"
    },
    "resource": {
      "input": {},
      "created_at": "2022-12-19T16:44:54Z",
      "output": null,
      "id": "document_photo_c0888",
      "updated_at": "2022-12-19T16:44:54Z",
      "task_def_version": null,
      "task_def_id": "upload_document_photo",
      "workflow_run_id": "0072fd81-7c5f-4bff-b3a9-7bea6ec3f838"
    }
  }
}
```

--------------------------------

### Configure Face Photo Introduction Screen (Android)

Source: https://documentation.identity.entrust.com/sdk/sdk-integration-guide-2025

Use the `FacePhoto` step with `showIntro: true` to display an introduction screen for non-workflow based sessions on Android. Ensure `entrustIdv.start` is called with `ClassicParameters` and the `steps` list.

```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
  ... 
  entrustIdv.start(ClassicParameters(
      ... 
      steps = listOf<Step<*>>(
        ... 
        FacePhoto(options = Options(showIntro = true))
      )
    )
  )
}
```

--------------------------------

### Initialize Onfido SDK with manual configuration

Source: https://documentation.identity.entrust.com/sdk/react-native/15.2.0

Use the Onfido.start method to launch the SDK with a manually defined flow configuration. Ensure the sdkToken is generated server-side and never expose API tokens in the frontend.

```javascript
import React, {Component} from 'react';
import {Button, View} from 'react-native';
import {
  Onfido,
  OnfidoCaptureType,
  OnfidoCountryCode,
  OnfidoDocumentType,
} from '@onfido/react-native-sdk';

export default class App extends Component {
  startSDK() {
    Onfido.start({
      sdkToken: "<YOUR_SDK_TOKEN>",
      flowSteps: {
        welcome: true,
        captureFace: {
          type: OnfidoCaptureType.VIDEO,
        },
        captureDocument: {
          docType: OnfidoDocumentType.DRIVING_LICENCE,
          countryCode: OnfidoCountryCode.GBR
        },
      },
    })
      .then(res => console.warn('OnfidoSDK: Success:', JSON.stringify(res)))
      .catch(err => console.warn('OnfidoSDK: Error:', err.code, err.message));
  }

  render() {
    return (
      <View style={{marginTop: 100}}>
        <Button title="Start Onfido SDK" onPress={() => this.startSDK()} />
      </View>
    );
  }
}
```

--------------------------------

### Proof of Address Report Example

Source: https://documentation.identity.entrust.com/api/latest

An example of a Proof of Address report object.

```APIDOC
### Proof of Address: Overall Result Logic

We've moved this content.

### Example Proof of Address report object

```json
{
  "created_at":"2021-04-27T14:51:35Z",
  "documents":[],
  "href":"/v3.6/reports/<REPORT_ID>",
  "id":"<REPORT_ID>",
  "name":"proof_of_address",
  "properties":{
     "document_type":"council_tax",
     "document_source_type": "pdf",
     "issuer":"city of london",
     "issue_date":"2020-01-01",
     "first_names":"John",
     "last_names":"Smith",
     "address":"123 sample street london xyz 1ab gbr",
     "address_parsed":{
        "country":"gbr",
        "postcode":"1ab gbr",
        "state":null,
        "town":"london"
     },
     "unsupported_document_reason": [
        "unsupported_doc_type",
        "unsupported_alphabet",
        "unsupported_country",
        "possible_fraud"
     ]
  },
  "result":"clear",
  "status":"complete",
  "sub_result":null,
  "breakdown":{
     "image_integrity":{
        "result":"clear",
        "breakdown":{
           "image_quality":{
              "result":"clear",
              "properties":{}
           }
        }
     },
     "document_classification":{
        "result":"clear",
        "breakdown":{
           "supported_document":{
              "result":"clear",
              "properties":{}
           },
           "valid_document_date":{
              "result":"clear",
              "properties":{}
           }
        }
     },
     "data_comparison":{
        "result":"clear",
        "breakdown":{
           "first_name":{
              "result":"clear",
              "properties":{}
           },
           "last_name":{
              "result":"clear",
              "properties":{}
           },
           "address":{
              "result":"clear",
              "properties":{}
           }
        }
     },
     "source_integrity": {
      "result": "clear",
      "breakdown": {
        "digital_tampering": {
          "result": "clear",
          "properties": {}
        },
        "visible_fraud": {
          "result": "clear",
          "properties": {}
        }
      }
    }
  },
  "check_id":"<CHECK_ID>"
}
```
```

--------------------------------

### Configure Face Photo Introduction Screen (iOS)

Source: https://documentation.identity.entrust.com/sdk/sdk-integration-guide-2025

Configure the `FacePhoto` step with `showIntro: true` for iOS to show an introduction screen in non-workflow based sessions. Initialize `EntrustIdv` with `ClassicParameters` and include the step in the `steps` array.

```swift
EntrustIdv(
  sdkParameters: ClassicParameters(
    ... 
    steps:[
      ... 
      FacePhoto( options: .init(
        showIntro: true
      ))
    ]
  )
)
```

--------------------------------

### Motion capture object example

Source: https://documentation.identity.entrust.com/api/latest

Example response structure for a motion capture resource.

```http
1HTTP/1.1 201 Created
2
3
4{
5  "id": "<MOTION_CAPTURE_ID>",
6  "created_at": "2022-11-12T17:12:44Z",
7  "href": "/v3.6/motion_captures/<MOTION_CAPTURE_ID>",
8  "download_href": "/v3.6/motion_captures/<MOTION_CAPTURE_ID>/download",
9  "file_name": "<FILE_NAME>.mp4",
10  "file_type": "video/mp4",
11  "file_size": 1431121
12}
```

--------------------------------

### Configure Welcome Step

Source: https://documentation.identity.entrust.com/sdk/ios

Adds the optional welcome screen to the SDK configuration.

```swift
1let config = try OnfidoConfig.builder()
2    .withWelcomeStep()
3    ...
4    .build()
```

--------------------------------

### Webhook Event Example (Report Completed)

Source: https://documentation.identity.entrust.com/api/3.2.0

An example of a webhook event object when a report is completed.

```APIDOC
## Webhook Event Example (Report Completed)

### Description
An example of a webhook event object when a report is completed.

### Response Example
```json
{
  "payload": {
    "resource_type": "report",
    "action": "report.completed",
    "object": {
      "id": "<REPORT_ID>",
      "status": "complete",
      "completed_at_iso8601": "2019-10-28T15:00:39Z",
      "href": "https://api.onfido.com/v3.2/reports/<REPORT_ID>"
    }
  }
}
```
```

--------------------------------

### Initialize Onfido SDK

Source: https://documentation.identity.entrust.com/sdk/android/23.4.0

Configure the SDK using the builder pattern, including token setup and custom flow definitions.

```kotlin
1val config = OnfidoConfig.builder(this@MainActivity)
2    .withSDKToken(“<YOUR_SDK_TOKEN_HERE>”)
3    .withNFC(NFCOptions.Disabled) //Disable NFC feature
4    .withCustomFlow(flowSteps)
5    .build()
```

--------------------------------

### GET /v3.2/watchlist_monitors/{monitor_id}/matches

Source: https://documentation.identity.entrust.com/api/3.2.0

Gets a list of match IDs and their enabled/disabled status for a monitor.

```APIDOC
## GET /v3.2/watchlist_monitors/{monitor_id}/matches

### Description
Gets a list of match IDs on this monitor, as well as their enabled/disabled status.

### Method
GET

### Endpoint
/v3.2/watchlist_monitors/{monitor_id}/matches

### Parameters
#### Path Parameters
- **monitor_id** (string) - Required - The ID of the monitor.

### Response
#### Success Response (200)
- **matches** (array) - List of match objects containing id and enabled status.

### Response Example
{
  "matches": [
    {
      "id": "<MATCH_ID>",
      "enabled": true
    }
  ]
}
```

--------------------------------

### Onfido.init() Configuration

Source: https://documentation.identity.entrust.com/sdk/web

Configuration options for customizing the cross-device experience during SDK initialization.

```APIDOC
## Onfido.init() Configuration

### Description
Customizes the cross-device flow behavior and branding during SDK initialization.

### Parameters
#### Request Body
- **_crossDeviceLinkMethods** (List<String>) - Optional - Specifies available link options (qr_code, copy_link, sms). First element is default.
- **smsNumberCountryCode** (String) - Optional - 2-character ISO country code for SMS input default (defaults to GB).
- **userDetails** (Object) - Optional - Pre-fills user information, including smsNumber.
- **crossDeviceClientIntroProductLogoSrc** (String) - Optional - Path to a custom logo image (max 144px x 144px).

### Request Example
{
  "_crossDeviceLinkMethods": ["qr_code", "copy_link", "sms"],
  "smsNumberCountryCode": "US",
  "userDetails": {
    "smsNumber": "+447500123456"
  },
  "crossDeviceClientIntroProductLogoSrc": "path://to/logo/image/file"
}
```

--------------------------------

### Retrieve Check Object Example

Source: https://documentation.identity.entrust.com/api/latest

Example of a successful HTTP 201 response containing a Check object.

```http
HTTP/1.1 201 Created

{
  "applicant_id": "<APPLICANT_ID>",
  "applicant_provides_data": false,
  "created_at": "2021-03-22T17:13:12Z",
  "form_uri": null,
  "href": "/v3.6/checks/<CHECK_ID>",
  "id": "<CHECK_ID>",
  "paused": false,
  "redirect_uri": null,
  "report_ids": [
    "<REPORT_ID>"
  ],
  "result": null,
  "results_uri": "<RESULTS_URI>",
  "sandbox": true,
  "status": "in_progress",
  "tags": [],
  "version": "3.6",
  "webhook_ids": null
}
```

--------------------------------

### Initialize React Native Project

Source: https://documentation.identity.entrust.com/sdk/react-native/15.2.0

Create a new React Native project using the CLI tool.

```shell
npx react-native init YourProjectName
```

--------------------------------

### Document Verification Response Example

Source: https://documentation.identity.entrust.com/api/3.2.0

Example of the properties returned in a Document report response object for a clear result.

```json
"drivers_licence": true,
"restricted_licence": false,
"raw_licence_category": "DRIVER LICENSE",
"raw_vehicle_classes": "AM,B",
"vehicle_class_details": [{
    "category": "AM",
    "obtainment_date": "2020-05-12",
    "expiry_date": "2030-05-12"
    },
    {
    "category": "B",
    "obtainment_date": "2020-05-12",
    "expiry_date": "2030-05-12"
    }
]
```

--------------------------------

### Configure SDK Initialization

Source: https://documentation.identity.entrust.com/sdk/react-native/15.2.0

Set up the SDK token, localization, and flow steps for the verification process. Ensure your SDK token is obtained from the SDK token API.

```javascript
1config = {
2  sdkToken: "<YOUR_SDK_TOKEN>",
3  localisation: {
4    ios_strings_file_name: 'Localizable',
5  },
6  flowSteps: {
7    ...
8  },
9}
```

--------------------------------

### Start the SDK Flow

Source: https://documentation.identity.entrust.com/sdk/ios/32.6.2

Initiate the configured Onfido flow from a view controller.

```swift
try onfidoRun.run(from: yourViewController, animated: true)
```

```objc
NSError *runError = NULL;
[onFlow runFrom:yourViewController animated:YES error:&runError completion:nil];

if (runError != NULL) {
    // do fallback logic
}
```

--------------------------------

### Manually Start Verification Flow

Source: https://documentation.identity.entrust.com/sdk/flutter

Initialize the verification flow manually by defining specific steps in the start function.

```dart
startOnfido() async {
  try {
    final response = await onfido.start(
      flowSteps: FlowSteps(
        proofOfAddress: true,
        welcome: true,
        documentCapture: DocumentCapture(),
        faceCapture: FaceCapture.photo(
          withIntroScreen: _introScreen,
        ),
      ),
    );
    ... handle response
  } catch (error) {
    ... handle error
  }
}
```

--------------------------------

### Example DLDV Report Object

Source: https://documentation.identity.entrust.com/api/3.2.0

An example of a complete DLDV report object, illustrating the nested structure of breakdown results.

```APIDOC
## Example DLDV Report Object

```json
{
    "created_at": "2021-03-26T19:51:37Z",
    "documents": [],
    "href": "/v3.2/reports/<REPORT_ID>",
    "id": "<REPORT_ID>",
    "name": "us_driving_licence",
    "properties": {},
    "result": "clear",
    "status": "complete",
    "sub_result": null,
    "breakdown": {
        "document": {
            "result": "clear",
            "breakdown": {
                "category": {
                    "result": "clear",
                    "properties": {}
                },
                "expiration_date": {
                    "result": "clear",
                    "properties": {}
                },
                "issue_date": {
                    "result": "clear",
                    "properties": {}
                },
                "document_number": {
                    "result": "clear",
                    "properties": {}
                }
            }
        },
        "address": {
            "result": "clear",
            "breakdown": {
                "city": {
                    "result": "clear",
                    "properties": {}
                },
                "line_1": {
                    "result": "clear",
                    "properties": {}
                },
                "line_2": {
                    "result": "clear",
                    "properties": {}
                },
                "state_code": {
                    "result": "clear",
                    "properties": {}
                },
                "zip4": {
                    "result": "clear",
                    "properties": {}
                },
                "zip5": {
                    "result": "clear",
                    "properties": {}
                }
            }
        },
        "personal": {
            "result": "clear",
            "breakdown": {
                "first_name": {
                    "result": "clear",
                    "properties": {}
                },
                "name_suffix": {
                    "result": "clear",
                    "properties": {}
                },
                "height": {
                    "result": "clear",
                    "properties": {}
                },
                "weight": {
                    "result": "clear",
                    "properties": {}
                },
                "sex_code": {
                    "result": "clear",
                    "properties": {}
                },
                "eye_color": {
                    "result": "clear",
                    "properties": {}
                },
                "date_of_birth": {
                    "result": "clear",
                    "properties": {}
                },
                "last_name": {
                    "result": "clear",
                    "properties": {}
                },
                "middle_name": {
                    "result": "clear",
                    "properties": {}
                },
                "first_name_fuzzy": {
                    "result": "clear",
                    "properties": {}
                },
                "middle_name_fuzzy": {
                    "result": "clear",
                    "properties": {}
                },
                "last_name_fuzzy": {
                    "result": "clear",
                    "properties": {}
                },
                "middle_initial": {
                    "result": "clear",
                    "properties": {}
                }
            }
        }
    },
    "check_id": "<CHECK_ID>"
}
```
```

--------------------------------

### Validation Error Response Example

Source: https://documentation.identity.entrust.com/api/3.2.0

An example of a 422 Unprocessable Entity response containing specific field validation errors.

```json
HTTP/1.1 422 Unprocessable Entity


{
  "error": {
    "type": "validation_error",
    "message": "",
    "fields": {
      "email": [
        "invalid format"
      ]
      "name": [
        "can't be blank"
      ]
    }
  }
}
```

--------------------------------

### Install Onfido Web SDK

Source: https://documentation.identity.entrust.com/sdk/web

Commands to add the Onfido SDK package to your project using NPM or Yarn.

```bash
npm install onfido-sdk-ui
```

```bash
yarn add onfido-sdk-ui
```

--------------------------------

### Identity Enhanced Report Example

Source: https://documentation.identity.entrust.com/api/latest

Provides an example of a complete Identity Enhanced report, including its metadata, properties, status, and breakdowns.

```APIDOC
## Identity Enhanced Report Example

### Response Example (200 OK)
```json
{
  "created_at": "2020-06-19T09:44:14Z",
  "documents": [],
  "href": "/v3.6/reports/<REPORT_ID>",
  "id": "<REPORT_ID>",
  "name": "known_faces",
  "properties": {
    "matches": [
      {
        "applicant_id": "<1ST_MATCHED_APPLICANT_ID>",
        "score": 1,
        "media_id": "<1ST_MEDIA_ID>",
        "media_type": "live_photos",
        "suspected": false
      },
      {
        "applicant_id": "<2ND_MATCHED_APPLICANT_ID>",
        "score": 1,
        "media_id": "<2ND_MEDIA_ID>",
        "media_type": "live_videos",
        "suspected": true
      }
    ]
  },
  "result": "consider",
  "status": "complete",
  "sub_result": null,
  "breakdown": {
    "previously_seen_faces": {
      "result": "consider"
    },
    "image_integrity": {
      "result": "clear"
    }
  },
  "check_id": "<CHECK_ID>"
}
```
```

--------------------------------

### Initialize Onfido SDK

Source: https://documentation.identity.entrust.com/sdk/web

Configuration for initializing the SDK with a token and workflow run ID.

```javascript
Onfido.init({
  token: '<YOUR_SDK_TOKEN>',
  containerId: 'onfido-mount',
  //containerEl: <div id="root" />, an ALTERNATIVE to `containerId`
  onComplete: function (data) {
    console.log('everything is complete')
  },
  workflowRunId: '<YOUR_WORKFLOW_RUN_ID>',
})
```

--------------------------------

### Example Document Report Object

Source: https://documentation.identity.entrust.com/api/latest

An example of the JSON response structure for a document report, illustrating various breakdown categories and their results.

```APIDOC
## Example Document Report Object

This is an example of the JSON response structure for a document report, illustrating various breakdown categories and their results.

### Response Example

```json
{
  "breakdown": {
    "age_validation": {
      "breakdown": {
        "minimum_accepted_age": {
          "properties": {},
          "result": "clear"
        }
      },
      "result": "clear"
    },
    "compromised_document": {
      "breakdown": {
        "document_database": {
          "properties": {},
          "result": "clear"
        },
        "repeat_attempts": {
          "properties": {},
          "result": "clear"
        }
      },
      "result": "clear"
    },
    "data_comparison": {
      "breakdown": {
        "date_of_birth": {
          "properties": {},
          "result": "clear"
        },
        "date_of_expiry": {
          "properties": {},
          "result": null
        },
        "document_numbers": {
          "properties": {},
          "result": null
        },
        "document_type": {
          "properties": {},
          "result": null
        },
        "first_name": {
          "properties": {},
          "result": "clear"
        },
        "gender": {
          "properties": {},
          "result": null
        },
        "issuing_country": {
          "properties": {},
          "result": null
        },
        "last_name": {
          "properties": {},
          "result": "clear"
        }
      },
      "result": "clear"
    },
    "data_consistency": {
      "breakdown": {
        "date_of_birth": {
          "properties": {},
          "result": "clear"
        },
        "date_of_expiry": {
          "properties": {},
          "result": "clear"
        },
        "document_numbers": {
          "properties": {},
          "result": "clear"
        },
        "document_type": {
          "properties": {},
          "result": "clear"
        },
        "first_name": {
          "properties": {},
          "result": "clear"
        },
        "gender": {
          "properties": {},
          "result": "clear"
        },
        "issuing_country": {
          "properties": {},
          "result": "clear"
        },
        "last_name": {
          "properties": {},
          "result": "clear"
        },
        "multiple_data_sources_present": {
          "properties": {},
          "result": "clear"
        },
        "nationality": {
          "properties": {},
          "result": "clear"
        }
      },
      "result": "clear"
    },
    "data_validation": {
      "breakdown": {
        "date_of_birth": {
          "properties": {},
          "result": "clear"
        },
        "document_expiration": {
          "properties": {},
          "result": "clear"
        },
        "document_numbers": {
          "properties": {},
          "result": "clear"
        },
        "expiry_date": {
          "properties": {},
          "result": "clear"
        },
        "gender": {
          "properties": {},
          "result": "clear"
        },
        "mrz": {
          "properties": {},
          "result": "clear"
        },
        "barcode": {
          "properties": {},
          "result": "clear"
        }
      },
      "result": "clear"
    },
    "image_integrity": {
      "breakdown": {
        "colour_picture": {
          "properties": {},
          "result": "clear"
        },
        "conclusive_document_quality": {
          "properties": {},
          "result": "clear"
        },
        "image_quality": {
          "properties": {},
          "result": "clear"
        },
        "supported_document": {
          "properties": {},
          "result": "clear"
        }
      },
      "result": "clear"
    },
    "police_record": {
      "result": "clear"
    },
    "visual_authenticity": {
      "breakdown": {
        "digital_tampering": {
          "properties": {},
          "result": "clear"
        },
        "face_detection": {
          "properties": {},
          "result": "clear"
        },
        "fonts": {
          "properties": {},
          "result": "clear"
        }
      }
    }
  }
}
```
```

--------------------------------

### Add Run Script Phase for Manual Installation

Source: https://documentation.identity.entrust.com/sdk/ios/migration

Remove unnecessary architectures from the Onfido framework during the build process.

```bash
1if [[ "$ACTION" != "install" ]]; then
2exit 0;
3fi
4
5FRAMEWORK_DIR="${CONFIGURATION_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}"
6ONFIDO_FRAMEWORK="${FRAMEWORK_DIR}/Onfido.framework"
7
8cd "${ONFIDO_FRAMEWORK}"
9
10lipo -remove i386 Onfido -o Onfido
11lipo -remove x86_64 Onfido -o Onfido
```

--------------------------------

### Example Facial Similarity Photo Report Object

Source: https://documentation.identity.entrust.com/api/3.2.0

An example JSON object representing a completed Facial Similarity Photo report.

```APIDOC
## GET /v3.2/reports/<REPORT_ID>

### Description
Retrieves a completed Facial Similarity Photo report.

### Method
GET

### Endpoint
`/v3.2/reports/<REPORT_ID>`

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the report.
- **name** (string) - The name of the report, e.g., "facial_similarity_photo".
- **properties** (object) - Contains properties related to the report.
- **breakdown** (object) - Contains detailed breakdowns of the report, including face comparison and spoofing detection.
  - **face_comparison** (object)
    - **face_match** (object)
      - **score** (float) - Similarity score between two faces (0 to 1).
      - **document_id** (string or null) - UUID of the document used for face matching.
  - **visual_authenticity** (object)
    - **spoofing_detection** (object)
      - **score** (float) - Spoofing detection score (0 to 1).

#### Response Example
```json
{
  "created_at": "2019-12-11T09:39:05Z",
  "href": "/v3.2/reports/<REPORT_ID>",
  "id": "<REPORT_ID>",
  "name": "facial_similarity_photo",
  "properties": {},
  "result": "clear",
  "status": "complete",
  "sub_result": null,
  "breakdown": {
    "face_comparison": {
      "result": "clear",
      "breakdown": {
        "face_match": {
          "result": "clear",
          "properties": {
            "score": 0.6512,
            "document_id": "<DOCUMENT_ID>"
          }
        }
      }
    },
    "image_integrity": {
      "result": "clear",
      "breakdown": {
        "face_detected": {
          "result": "clear",
          "properties": {}
        },
        "source_integrity": {
          "result": "clear",
          "properties": {}
        }
      }
    },
    "visual_authenticity": {
      "result": "clear",
      "breakdown": {
        "spoofing_detection": {
          "result": "clear",
          "properties": {
            "score": 0.9512
          }
        }
      }
    }
  },
  "check_id": "<CHECK_ID>",
  "documents": []
}
```
```

--------------------------------

### Example Webhook Event Object

Source: https://documentation.identity.entrust.com/api/3.2.0

This is an example of a 'report.completed' webhook event payload. Ensure your webhook endpoint can parse and process this JSON structure.

```json
{
  "payload": {
    "resource_type": "report",
    "action": "report.completed",
    "object": {
      "id": "<REPORT_ID>",
      "status": "complete",
      "completed_at_iso8601": "2019-10-28T15:00:39Z",
      "href": "https://api.onfido.com/v3.2/reports/<REPORT_ID>"
    }
  }
}
```

--------------------------------

### US Identity Enhanced Report Example

Source: https://documentation.identity.entrust.com/api/latest

Example of an Identity Enhanced report object for an applicant with a US address. Includes SSN breakdown when provided.

```json
1HTTP/1.1 201 Created


{
  "check_id": "<CHECK_ID>",
  "created_at": "2022-05-06T08:44:54Z",
  "documents": [],
  "href": "/v3.6/reports/<REPORT_ID>",
  "id": "<REPORT_ID>",
  "name": "identity_enhanced",
  "properties": {},
  "result": "clear",
  "status": "complete",
  "sub_result": null,
  "breakdown": {
    "date_of_birth": {
      "result": "clear",
      "breakdown": {
        "date_of_birth_matched": {
          "result": "clear",
          "properties": {
            "sources": "Credit Agencies"
          }
        }
      }
    },
    "address": {
      "result": "clear",
      "breakdown": {
        "address_matched": {
          "result": "clear",
          "properties": {
            "sources": "Credit Agencies, Telephone Database"
          }
        }
      }
    },
    "ssn": {
      "result": "clear",
      "breakdown": {
        "last_4_digits_match": {
          "result": "clear",
          "properties": {}
        },
        "full_match": {
          "result": "clear",
          "properties": {}
        }
      }
    }
  }

}
```

--------------------------------

### Example Live Photo Object Response

Source: https://documentation.identity.entrust.com/api/latest

This is an example of a live photo object returned after a successful upload or retrieval. It contains metadata about the uploaded image.

```httpbash
HTTP/1.1 201 Created

{
  "id": "<LIVE_PHOTO_ID>",
  "created_at": "2019-10-09T16:59:06Z",
  "file_name": "<FILE_NAME>.png",
  "file_type": "image/png",
  "file_size": 536630,
  "href": "/v3.6/live_photos/<LIVE_PHOTO_ID>",
  "download_href": "/v3.6/live_photos/<LIVE_PHOTO_ID>/download"
}
```

--------------------------------

### Initialize Onfido SDK with Custom Steps

Source: https://documentation.identity.entrust.com/sdk/web

Initialize the Onfido Web SDK with a custom JWT token and define a specific order of verification steps, including a customized welcome screen.

```javascript
Onfido.init({
  token: "<YOUR_SDK_TOKEN>",
  ...
  steps: [
    {
      type: "welcome",
      options: {
        title: "Open your new bank account",
      },
    },
    "document",
    "poa",
    "face",
  ];
});
```

--------------------------------

### Example Passkey Object Response

Source: https://documentation.identity.entrust.com/api/latest

This is an example of a successful response when retrieving a passkey object, detailing its ID, associated domain, state, and creation/usage timestamps.

```http
HTTP/1.1 200 OK

{
    "id": "974730da-bf5b-4e9f-9461-e935fdd1f4b2",
    "application_domain": "your-domain.com",
    "state": "ACTIVE",
    "created_at": "2025-02-19T13:15:27Z",
    "last_used_at": "2025-05-19T13:15:27Z"
}
```

--------------------------------

### Configure Proof of Address Step

Source: https://documentation.identity.entrust.com/sdk/ios

Initializes the Proof of Address step configuration for Swift and Objective-C.

```swift
1let config = try OnfidoConfig.builder()
2    .withSDKToken("<YOUR_SDK_TOKEN_HERE>")
3    .withProofOfAddressStep()
4    .build()
```

```objc
1ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder];
2[configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"];
3[configBuilder withProofOfAddressStep];
4
5NSError *configError = NULL;
6ONFlowConfig *config = [configBuilder buildAndReturnError:&configError];
7
8if (configError) {
9    // Handle config build error
10} else {
11    // use config
12}
```

--------------------------------

### Initialize SDK Configuration Object

Source: https://documentation.identity.entrust.com/sdk/react-native

Create the configuration object using the SDK token and workflow run ID to initialize the client.

```javascript
config = {
  sdkToken: "<YOUR_SDK_TOKEN>",
  workflowRunId: "<YOUR_WORKFLOW_RUN_ID>"
}
```

--------------------------------

### Document Report 'clear' Result Example

Source: https://documentation.identity.entrust.com/guide/document-report

This JSON snippet shows an example of a 'clear' result for the 'image_integrity' breakdown in a Document Report, specifically for 'video_document_presence'.

```json
1"image_integrity": {
2      "breakdown": {
3        "video_document_presence": {
4          "properties": {},
5          "result": "clear"
6        }
7      },
8    "result": "clear"
9  }
```

--------------------------------

### Configure Face Photo Introduction Screen (React Native)

Source: https://documentation.identity.entrust.com/sdk/sdk-integration-guide-2025

In React Native, use `FacePhoto` with `showIntro: true` to enable the introduction screen for non-workflow based flows. Call `entrustIdv.start` with the `steps` array containing the configured `FacePhoto` object.

```javascript
entrustIdv.start({
  ... 
  steps: [
    ... 
    FacePhoto({
      showIntro: true,
    }),
  ],
});
```

--------------------------------

### HTML Structure for Hosting Onfido Web SDK

Source: https://documentation.identity.entrust.com/sdk/web/14.62.0

This HTML file serves as a basic setup for hosting the Onfido Web SDK. It includes necessary meta tags, styles, and scripts, initializing the SDK with a `roomId` extracted from the URL.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta
      charset="utf-8"
      name="viewport"
      content="width=device-width, initial-scale=1"
    />
    <meta name="mobile-web-app-capable" content="yes" />
    <meta name="apple-mobile-web-app-capable" content="yes" />
    <meta name="format-detection" content="telephone=no" />
    <title>Onfido Verification</title>
    <style type="text/css">
      html,
      body {
        height: 100%;
        margin: 0;
      }
      body,
      button {
        -webkit-font-smoothing: antialiased;
      }
      @media (min-width: 30em) {
        #onfido-mount {
          position: relative;
          top: 10%;
        }
        .onfido-sdk-ui-Modal-inner {
          font-family: 'Open Sans', sans-serif !important;
        }
      }
    </style>
    <!-- Important: You must use the same version as you are using on the desktop -->
    <script src="https://sdk.onfido.com/v14" charset="utf-8"></script>
  </head>

  <body>
    <div id="onfido-mount"></div>
    <script type="text/javascript">
      /*
        Get the roomId from the url (last 6 characters)
        Example:
        - https://example.com/XXCOXCKL -> roomId (COXCKL)
      */
      var roomId = window.location.pathname.substring(3, 9)

      Onfido.init({
        containerId: 'onfido-mount',
        roomId,
      })
    </script>
  </body>
</html>

```
Tokens:
Raw