Uqudo

https://docs.uqudo.com/docs
Admin
Uqudo is a comprehensive digital identity verification and management platform that offers secure...
Tokens:83,546
Snippets:812
Trust Score:9.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Manual NuGet Configuration

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/plugin-installation.md

Example of a NuGet.Config file with the uqudo repository added.

```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <packageSources>
   <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
   <add key="uqudo" value="https://rm.dev.uqudo.io/repository/nuget-hosted/" protocolVersion="3" />
 </packageSources>
</configuration>
```

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

### Install Uqudo web SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/sdk-installation/js-frameworks-react-angular-vuejs-etc....md

Use these commands to install the Uqudo web SDK package from the npm registry.

```shell
npm install uqudosdk-web
```

```shell
yarn add uqudosdk-web
```

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

### Enrollment Implementation

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/javascript-usage.md

Full HTML example demonstrating how to trigger an enrollment process with passport scanning and background checks.

```javascript
<!DOCTYPE html>
<html lang="en">
  <head>
	<meta charset="UTF-8" />
	<meta http-equiv="X-UA-Compatible" content="IE=edge" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
	<link rel="stylesheet" href="./styles.css" />
	<title>Uqudo sample</title>
	<style></style>
  </head>
  <body>
	<div id="uq_container"></div>
	<button class="uq-button" id="enrollment.passport.button">
  	enrollment passport
	</button>
	<script type="text/javascript" src="./UqudoSDK.js"></script>
	<script>
  	const UQUDO_ACCESS_TOKEN = "token";

  	const uqudoSdkFactory = UqudoSDK.default;
  	const DocumentType = UqudoSDK.DocumentType;
  	const BackgroundCheckType = UqudoSDK.BackgroundCheckType;

  	const uqudoSdk = uqudoSdkFactory.create({
    	  accessToken: UQUDO_ACCESS_TOKEN,
  	});

  	function enrollmentPassport() {
    	  console.debug("enrollment start");
    	  uqudoSdk.enrollment({
      	    scan: {
        	documentType: DocumentType.PASSPORT,
                disableExpiryValidation: false,
                forceUpload: false,
      	    },
      	    face: {
              enableFacialRecognition: true,
      	    },
      	    backgroundCheck: {
              enableBackgroundCheck: true,
              checkType: BackgroundCheckType.RDC,
              skipView: true,
      	    },
      	    onError: function (error) {
        	console.debug("error from callback function ", error.message);
      	    },
      	    onSuccess: function (res) {
        	console.debug("result from callback function ", res);
      	    },
            onTrace: (trace) => {
              console.debug("trace callback function ", trace);
            }
    	  });
  	}

  	function onClickEvent(id, func) {
    	  document.getElementById(id)?.addEventListener("click", func, false);
  	}
  	onClickEvent("enrollment.passport.button", enrollmentPassport);
	</script>
  </body>
</html>
```

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

### Configure WebView for uqudo SDK in Android

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/webview-integration

These examples demonstrate how to initialize a WebView, enable required settings, and handle camera permission requests for video capture.

```java
package com.example.myapplication;
import android.Manifest;
import android.os.Build;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.webkit.PermissionRequest;
import android.webkit.WebChromeClient;
import android.webkit.WebSettings;
import android.webkit.WebView;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.content.ContextCompat;

public class MainActivity extends AppCompatActivity {

            @Override
            protected void onCreate(Bundle savedInstanceState) {
                super.onCreate(savedInstanceState);
                setContentView(R.layout.activity_main);
                WebView webView = findViewById(R.id.webView);
                WebSettings webSettings = webView.getSettings();
                
                // Enable Javascript
                webSettings.setJavaScriptEnabled(true);
                webSettings.setDomStorageEnabled(true);

                // Check camera permission and request if not granted
                if (ContextCompat.checkSelfPermission(this, Manifest.permission.CAMERA) != PackageManager.PERMISSION_GRANTED) {
                    ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.CAMERA}, 1);
                }
                webView.setWebChromeClient(new WebChromeClient() {
                    @Override
                    public void onPermissionRequest(final PermissionRequest request) {
                        // Check for camera permission
                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
                            for (String permission : request.getResources()) {
                                if (PermissionRequest.RESOURCE_VIDEO_CAPTURE.equals(permission)) {
                                    runOnUiThread(new Runnable() {
                                        @Override
                                        public void run() {
                                            if (ContextCompat.checkSelfPermission(MainActivity.this, Manifest.permission.CAMERA) == PackageManager.PERMISSION_GRANTED) {                                        
                                                request.grant(new String[]{PermissionRequest.RESOURCE_VIDEO_CAPTURE});                  
                                            } else {
                                                request.deny();
                                            }}});
                                    return;
                                }}}}
                        super.onPermissionRequest(request);
                    }
                });
                webView.loadUrl("https://your-uqudo-sdk-url.com");
            }}
```

```kotlin
package com.example.myapplication

import android.Manifest
import android.content.pm.PackageManager
import android.os.Build
import android.os.Bundle
import android.webkit.PermissionRequest
import android.webkit.WebChromeClient
import android.webkit.WebSettings
import android.webkit.WebView
import androidx.appcompat.app.AppCompatActivity
import androidx.core.app.ActivityCompat
import androidx.core.content.ContextCompat

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        val webView = findViewById<WebView>(R.id.webView)
        val webSettings = webView.settings

        // Enable Javascript
        webSettings.javaScriptEnabled = true
        webSettings.domStorageEnabled = true

        // Check camera permission and request if not granted
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.CAMERA) != PackageManager.PERMISSION_GRANTED) {
            ActivityCompat.requestPermissions(this, arrayOf(Manifest.permission.CAMERA), 1)
        }

        webView.webChromeClient = object : WebChromeClient() {
            override fun onPermissionRequest(request: PermissionRequest) {
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
                    for (permission in request.resources) {
                        if (PermissionRequest.RESOURCE_VIDEO_CAPTURE.equals(permission)) {
                            runOnUiThread {
                                if (ContextCompat.checkSelfPermission(this@MainActivity, Manifest.permission.CAMERA) == PackageManager.PERMISSION_GRANTED) {
                                    request.grant(arrayOf(PermissionRequest.RESOURCE_VIDEO_CAPTURE))
                                } else {
                                    request.deny()
                                }
                            }
                            return
                        }
                    }
                }
                super.onPermissionRequest(request)
            }
        }
        webView.loadUrl("https://your-uqudo-sdk-url.com")
    }
}
```

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

### Initiate Face Session

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/cordova/face-session-flow.md

Build the face session configuration and start the session process.

```javascript
var token = "<please put your token here>";
var faceSession = new cordova.plugins.UqudoIdPlugin.FaceSessionConfigurationBuilder()
	.setToken(token)
	.setSessionId("<your session id>")
	.setAppearanceMode(cordova.plugins.UqudoIdPlugin.AppearanceMode.DARK)
	.build();
cordova.plugins.UqudoIdPlugin.faceSession(faceSession, success, failure);
```

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

### Initialize the SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/ios/usage.md

Initialize the UQBuilderController once when the application starts, typically in the AppDelegate.

```APIDOC
## Initialize SDK

### Description
Initialize the UQBuilderController instance in the application delegate to prepare the SDK for use.

### Objective-C
```objectivec
[[UQBuilderController alloc] init];
```

### Swift
```swift
UQBuilderController()
```
```

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

### Initiate Enrolment Process

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/react-native/enrolment-flow.md

Example of configuring and starting an enrolment flow for a passport with NFC reading and facial recognition.

```javascript
var token = "<please put your token here>";
try {
    var passport = new DocumentBuilder()
			      .setDocumentType(DocumentType.PASSPORT)
			      .enableReading(new ReadingConfigurationBuilder()
			          .forceReadingIfSupported(true)
			          .build()
			      )
			      .build();
    var enrollmentConfiguration = new EnrollmentBuilder()
			      .setToken(token)
                              .enableFacialRecognition()
			      .add(passport)
                              .setAppearanceMode(AppearanceMode.SYSTEM)
   			      .build();
   const sdk = new UqudoIdSDK();
   const result = await sdk.enroll(enrollmentConfiguration);
   console.log(result);
} catch (error) {
   console.log(JSON.parse(error.code));
   // {"code":"USER_CANCEL","message":"User canceled the Enrollment process","task":"SCAN"}
}
```

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

### Initiate Lookup Flow

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/cordova/lookup-flow.md

Configure and start the lookup flow using the LookupBuilder.

```javascript
var lookupConfiguration =  new cordova.plugins.UqudoIdPlugin.LookupBuilder()
            .setToken(token)
            .setDocumentType(cordova.plugins.UqudoIdPlugin.DocumentType.NGA_DL)
            .enableFacialRecognition(
            	new cordova.plugins.UqudoIdPlugin.FacialRecognitionConfigurationBuilder()
            		.setLookupMinimumMatchLevel(4)
            		.build()
            )
            .enableBackgroundCheck(
            	new cordova.plugins.UqudoIdPlugin.BackgroundCheckConfigurationBuilder()
            		.skipView()
            		.build()
            )
            .build();
cordova.plugins.UqudoIdPlugin.lookup(lookupConfiguration, success, failure);
```

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

### Initiate Enrollment Flow

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/enrolment-flow.md

Use the UqudoBuilder to configure the enrollment flow, including document reading and facial recognition, then start the activity.

```kotlin
try {
   val authorizationToken = ... // access_token from the API response
   val uqudoIntent = UqudoBuilder.Enrollment()
            .setToken(authorizationToken)
            .add(
                DocumentBuilder(applicationContext)
                    .setDocumentType(DocumentType.PASSPORT)
                    .enableReading(ReadingConfigurationBuilder()
                        .forceReadingIfSupported(true)
                        .build()
                    )
                    .build()
            )
            .enableFacialRecognition()
            .build(this)
        startActivityForResult(uqudoIntent, 101)
} catch( e: Exception ){
    ...
}
```

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

### Face Session Implementation

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/javascript-usage.md

Full HTML example demonstrating how to trigger a face session using a specific session ID.

```javascript
<!DOCTYPE html>
<html lang="en">
  <head>
	<meta charset="UTF-8" />
	<meta http-equiv="X-UA-Compatible" content="IE=edge" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
	<link rel="stylesheet" href="./styles.css" />
	<title>Uqudo sample</title>
	<style></style>
  </head>
  <body>
	<div id="uq_container"></div>
	<button class="uq-button" id="faceSession.button">
  	Face Session
	</button>
	<script type="text/javascript" src="./UqudoSDK.js"></script>
	<script>
  	const UQUDO_ACCESS_TOKEN = "token";

  	const uqudoSdkFactory = UqudoSDK.default;
  	const DocumentType = UqudoSDK.DocumentType;
  	const BackgroundCheckType = UqudoSDK.BackgroundCheckType;

  	const uqudoSdk = uqudoSdkFactory.create({
    	  accessToken: UQUDO_ACCESS_TOKEN,
  	});

      function faceSession() {
        console.debug("faceSession start");
        uqudoSdk.faceSession({
          sessionId: "session id",
          onError: function (error) {
            console.debug("error from callback function ", error.message);
          },
          onSuccess: function (res) {
            console.debug("result from callback function ", res);
          },
          onTrace: (trace) => {
            console.debug("trace callback function ", trace);
          }
        });
      }

  	function onClickEvent(id, func) {
    	  document.getElementById(id)?.addEventListener("click", func, false);
  	}
  	onClickEvent("faceSession.button", faceSession);
	</script>
  </body>
</html>
```

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

### Install Capacitor Plugin

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/capacitor/plugin-installation.md

Execute this command within the root directory of your Capacitor project to add the uqudo SDK dependency.

```shell
npm install uqudosdk-capacitor --save
```

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

### Initiate Android Face Session

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/face-session-flow.md

Configure and start the face session, then handle the result in OnActivityResult.

```csharp
var faceSessionConfiguration = new IO.Uqudo.Sdk.Core.UqudoBuilder.FaceSession();
faceSessionConfiguration.SetSessionId("<your session identifier>");
faceSessionConfiguration.SetToken("<your token>");
StartActivityForResult(faceSessionConfiguration.Build(this), 100);
...
protected override void OnActivityResult(int requestCode, [GeneratedEnum] Result resultCode, Intent data) {
   	base.OnActivityResult(requestCode, resultCode, data);
   if (requestCode == 100) {
 	Console.WriteLine("JWS result" + data.GetStringExtra("data"));
   }
}
```

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

### Install uqudo Flutter SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/flutter/plugin-installation.md

Run this command in the terminal within your Flutter project directory to add the dependency.

```shell
flutter pub add uqudosdk_flutter
```

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

### Example Tracing Log Output

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/analytics.md

Sample log output showing a sequence of events during an enrollment flow.

```text
2021-02-04 09:42:38.632 18994-19168/io.uqudo.demo D/---Analytics: Trace(sessionId=, category=SDK, event=INIT, status=SUCCESS, page=null, statusCode=null, statusMessage=null, documentType=null, timestamp=Thu Feb 04 09:37:38 GMT+07:00 2021)
2021-02-04 09:42:39.117 18994-19190/io.uqudo.demo D/---Analytics: Trace(sessionId=fd86bab1-7b95-4f0e-a6ba-d5322c4a19e2, category=ENROLLMENT, event=VIEW, status=SUCCESS, page=SCAN, statusCode=null, statusMessage=null, documentType=PASSPORT, timestamp=Thu Feb 04 09:42:39 GMT+07:00 2021)
2021-02-04 09:42:45.798 18994-19168/io.uqudo.demo D/---Analytics: Trace(sessionId=fd86bab1-7b95-4f0e-a6ba-d5322c4a19e2, category=ENROLLMENT, event=START, status=SUCCESS, page=SCAN, statusCode=null, statusMessage=null, documentType=PASSPORT, timestamp=Thu Feb 04 09:42:45 GMT+07:00 2021)
2021-02-04 09:42:52.749 18994-19190/io.uqudo.demo D/---Analytics: Trace(sessionId=fd86bab1-7b95-4f0e-a6ba-d5322c4a19e2, category=ENROLLMENT, event=COMPLETE, status=FAILURE, page=SCAN, statusCode=SCAN_DOCUMENT_NOT_RECOGNIZED, statusMessage=null, documentType=PASSPORT, timestamp=Thu Feb 04 09:42:52 GMT+07:00 2021)
2021-02-04 09:42:53.736 18994-19168/io.uqudo.demo D/---Analytics: Trace(sessionId=fd86bab1-7b95-4f0e-a6ba-d5322c4a19e2, category=ENROLLMENT, event=START, status=SUCCESS, page=SCAN, statusCode=null, statusMessage=null, documentType=PASSPORT, timestamp=Thu Feb 04 09:42:53 GMT+07:00 2021)
2021-02-04 09:43:03.767 18994-19190/io.uqudo.demo D/---Analytics: Trace(sessionId=fd86bab1-7b95-4f0e-a6ba-d5322c4a19e2, category=ENROLLMENT, event=COMPLETE, status=SUCCESS, page=SCAN, statusCode=null, statusMessage=null, documentType=PASSPORT, timestamp=Thu Feb 04 09:43:03 GMT+07:00 2021)
2021-02-04 09:43:03.871 18994-19168/io.uqudo.demo D/---Analytics: Trace(sessionId=fd86bab1-7b95-4f0e-a6ba-d5322c4a19e2, category=ENROLLMENT, event=VIEW, status=SUCCESS, page=READ, statusCode=null, statusMessage=null, documentType=PASSPORT, timestamp=Thu Feb 04 09:43:03 GMT+07:00 2021)
```

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

### Initiate Face Session

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/face-session-flow.md

Build the face session using the required authorization token and session ID, then start the activity.

```kotlin
val uqudo = UqudoBuilder.FaceSession()
   .setToken(authorizationToken)
   .setSessionId(sessionId)
   .build(requireContext())
startActivityForResult(uqudo, REQUEST_CODE)
```

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

### Install uqudo SDK Cordova plugin

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/cordova/plugin-installation.md

Execute this command within the root directory of your Cordova project to add the plugin.

```shell
cordova plugin add uqudosdk-cordova
```

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

### Initiate Enrolment Process

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/flutter/enrolment-flow.md

Example of starting an enrolment for a passport with NFC reading and facial recognition enabled.

```dart
import 'package:uqudosdk_flutter/UqudoIdPlugin.dart';
import 'package:uqudosdk_flutter/uqudosdk_flutter.dart';
...

String result;
try {
  var token = "your token";
  var doc = new DocumentBuilder()
      .setDocumentType(DocumentType.PASSPORT)
      .enableReading(new ReadingConfigurationBuilder()
          .forceReadingIfSupported(true)
          .build()
      )
      .build();
  var enrollObject = new EnrollmentBuilder()
      .setToken(token)
      .add(doc)
      .setAppearanceMode(AppearanceMode.SYSTEM)
      .build();
  result = await UqudoIdPlugin.enroll(enrollObject);
} on PlatformException catch (exception) {
  result = exception.code;
   // {"code":"USER_CANCEL","message":"User canceled the Enrollment process","task":"SCAN"}
}
```

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

### Initialize Uqudo SDK Instance

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/javascript-usage.md

Create an instance of the SDK using your access token.

```javascript
<script>
      const uqudoSdkFactory = UqudoSDK.default;
      const DocumentType = UqudoSDK.DocumentType;
      const BackgroundCheckType = UqudoSDK.BackgroundCheckType;
      
      const uqudoSdk = uqudoSdkFactory.create({
    	  accessToken: UQUDO_ACCESS_TOKEN,
  	});
</script>
```

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

### Enrollment Payload Example

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/sdk-result/validation-and-parsing.md

Example of the JSON payload returned for an enrollment process.

```json
{
  "aud": "clientid",
  "data": {
    "documents": [
      {
        "face": {
          "auditTrailImageId": "5f290764076cff0e3f7b3a2f",
          "matchLevel": 2,
          "match": true
        },
        "documentType": "PASSPORT",
        "scan": {
          "faceImageId": "5e9960242d35cc7ca0328729",
          "frontImageId": "5e9960232d35cc7ca0328725",
          "back": {},
          "front": {
            "documentCode": "P<",
            "dateOfExpiry": "220315",
            "secondaryId": "MARIO",
            "nationality": "ITA",
            "documentNumber": "YAXXXXXX",
            "mrzVerified": true,
            "sex": "M",
            "dateOfBirth": "800825",
            "opt1": "<<<<<<<<<<<<<<",
            "primaryId": "CASOLA",
            "mrzText": "P<ITACASOLA<<MARIO<<<<<<<<<<<<<<<<<<<<<<<<<<\nYAXXXXXX52ITA8008253M2203159<<<<<<<<<<<<<<00",
            "issuer": "ITA"
          },
          "backImageId": null
        },
        "reading": {
          "data": {
            "mrz": {
              "documentCode": "P",
              "dateOfExpiry": "220315",
              "optionalData2": null,
              "gender": "MALE",
              "nationality": "ITA",
              "documentNumber": "YAXXXXXX",
              "dateOfBirth": "800825",
              "issuingState": "ITA",
              "secondaryIdentifier": "MARIO",
              "primaryIdentifier": "CASOLA",
              "optionalData1": "<<<<<<<<<<<<<<0"
            },
            "countrySigningCertificate": {
              "serialNumber": "1",
              "publicKeyAlgorithm": "RSA",
              "subject": "C=IT,O=MINISTERO DELL'INTERNO,OU=PE,CN=CERTIFICATION AUTHORITY 01",
              "certificateThumbprint": "9cb8d31734faa68009d1f7fef68a5cc802cb8a2e",
              "validFrom": "2011-12-14T10:29:04.000+0000",
              "signatureAlgorithm": "SHA1WITHRSA",
              "issuer": "C=IT,O=MINISTERO DELL'INTERNO,OU=PE,CN=CERTIFICATION AUTHORITY 01",
              "validTo": "2027-03-10T10:29:04.000+0000"
            },
            "ldsVersion": null,
            "documentSigningCertificate": {
              "serialNumber": "464",
              "publicKeyAlgorithm": "RSA",
              "subject": "C=IT,O=MINISTERO DELL'INTERNO,OU=PE,CN=DOCUMENT SIGNER.24",
              "certificateThumbprint": "3f0b7bac9adde63916a2c4ebd0e3f38c916a3a97",
              "validFrom": "2012-03-14T11:02:41.000+0000",
              "signatureAlgorithm": "SHA1WITHRSA",
              "issuer": "C=IT,O=MINISTERO DELL'INTERNO,OU=PE,CN=CERTIFICATION AUTHORITY 01",
              "validTo": "2022-06-15T11:02:41.000+0000"
            },
            "photo": "",
            "dataGroupHashes": [
              {
                "computedHash": "86525f4741b3504765f4100f2ddf9bf1f17380ef",
                "dataGroupNumber": 1,
                "storedHash": "86525f4741b3504765f4100f2ddf9bf1f17380ef",
                "match": true
              },
              {
                "computedHash": "b01c95fc9d381f6a7f5fd9f3fae767ea0d9fd2a0",
                "dataGroupNumber": 2,
                "storedHash": "b01c95fc9d381f6a7f5fd9f3fae767ea0d9fd2a0",
                "match": true
              }
            ],
            "photoMimeType": "image/jp2",
            "validity": {
              "dataGroupHashesSucceeded": true,
              "documentSignerSucceeded": true,
              "countrySignerSucceeded": true,
              "sodSignerSucceeded": true
            }
          }
        }
      }
    ],
    "nonce": ""
  },
  "iss": "https://id.uqudo.io",
  "exp": 1587111760,
  "iat": 1587109960,
  "jti": "5a5cb56b-ef3d-434c-9f86-5ab24c4953ec"
}
```

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

### Face Session Payload Example

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/sdk-result/validation-and-parsing.md

Example of the JSON payload returned for a face session.

```json
{
  "aud": "client_id",
  "data": {
    "face": {
      "auditTrailImageId": "5eabf184827ca836b8e28cf0",
      "matchLevel": 5,
      "match": true
    },
    "sessionId": "962cd61a-87b2-4c53-b415-27c053c9b281"
  },
  "iss": "https://id.uqudo.io",
  "exp": 1588327388,
  "iat": 1588326788,
  "jti": "6049f9c6-756e-48d7-b1ca-bbd00fef7d14"
}
```

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

### Initialize uqudo SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/cordova/face-session-flow.md

Initialize the SDK at application startup using the provided trace callback.

```javascript
function traceCallback(result) {
	console.log('----Trace=' + result);
};
function success(result) {
	console.log('----Result=' + result);
};
function failure(error) {
	console.log('----Result=' + JSON.parse(error));
};

...
// On App startup
cordova.plugins.UqudoIdPlugin.init(traceCallback);
...
```

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

### UAE_ID Scan Response Example

Source: https://docs.uqudo.com/docs/kyc/uqudo-api/scan.md

A detailed example of the JSON response body returned after scanning a UAE_ID document.

```json
{
  "front": {
    "fullName": "Mario Casola",
    "identityNumber": "784-19XX-XXXXXXX-9",
    "nationality": "Italy",
    "faceImage": "<base64 encoded face image>"
  },
  "back": {
    "secondaryId": "MARIO",
    "primaryId": "CASOLA",
    "dateOfBirth": "800825",
    "dateOfExpiry": "200306",
    "documentNumber": "0880XXX20",
    "serialNumber": "0B800029B46XXXXX",
    "nationality": "ITA",
    "issuer": "ARE",
    "sex": "M",
    "documentCode": "IL",
    "mrzText": "ILARE0880XXX20378419XXXXXXXXX9\n8008253M2003061ITA<<<<<<<<<<<9\nCASOLA<<MARIO<<<<<<<<<<<<<<<<<\n",
    "mrzVerified": true,
    "opt1": "78419XXXXXXXXX9",
    "opt2": "<<<<<<<<<<<"
  }
}
```

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

### UqudoIdSDK.init()

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/react-native/lookup-flow.md

Initializes the uqudo SDK instance at application startup.

```APIDOC
## UqudoIdSDK.init()

### Description
Initializes the SDK instance. This should be called during the application startup phase.

### Method
`this.sdk.init()`

### Example
```javascript
this.sdk = new UqudoIdSDK();
this.sdk.init();
```
```

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

### UqudoPlugin.init()

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/capacitor/enrolment-flow.md

Initializes the uqudo SDK. This should be called at the start-up of your application.

```APIDOC
## UqudoPlugin.init()

### Description
Initializes the uqudo SDK instance.

### Method
`new UqudoSDK.UqudoPlugin().init()`
```

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

### Query documentation via HTTP GET

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/webview-usage

Perform an HTTP GET request to the documentation index to retrieve answers to specific questions.

```http
GET https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/typescript-usage.md?ask=<question>&goal=<end_goal>
```

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

### GET /api/v1/info

Source: https://docs.uqudo.com/docs/kyc/uqudo-api/info.md

Retrieves information related to the info API.

```APIDOC
## GET /api/v1/info

### Description
Retrieves information related to the info API.

### Method
GET

### Endpoint
/api/v1/info
```

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

### UqudoSDK.init

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/face-session-flow.md

Initializes the Uqudo SDK with the application context.

```APIDOC
## UqudoSDK.init(applicationContext)

### Description
Initializes the Uqudo SDK. This method should be called when the application is initiated.

### Parameters
- **applicationContext** (Context) - Required - The application context.
```

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

### Initialize the SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/react-native/enrolment-flow.md

Initialize the SDK during application startup.

```javascript
import { 
  DocumentBuilder,
  DocumentType, 
  EnrollmentBuilder, 
  UqudoIdSDK,
  ReadingConfigurationBuilder
} from 'uqudosdk-react-native';

...
//On App startup
constructor(){
    super()
    new UqudoIdSDK().init();
  }
...
```

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

### GET /api/v1/info/img/{id}

Source: https://docs.uqudo.com/docs/kyc/uqudo-api/info.md

Downloads an image based on the resource ID.

```APIDOC
## GET /api/v1/info/img/{id}

### Description
Allows you to download the image based on the resource ID provided in the SDK result. Returns the binary image data directly in the response.

### Method
GET

### Endpoint
/api/v1/info/img/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The resource ID of the image.
```

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

### Initialize SDK with Tracer

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/ios/analytics.md

Configures the UQBuilderController with a tracer instance during application startup.

```objectivec
@implementation AppDelegate

- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary<UIApplicationLaunchOptionsKey,id> *)launchOptions {
    UQTracer *tracer = [[UQTracer alloc] init];
    [[UQBuilderController alloc] initWithTracer:tracer];
    return YES;
}
@end
```

```swift
class AppDelegate: UIResponder, UIApplicationDelegate {
        
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        let tracer = UQTracer()
        _ = UQBuilderController.init(tracer: tracer)
        return true
    }
}
```

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

### uqudoSdkFactory.create()

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/sdk-initialisation.md

Initializes a new instance of the uqudo SDK with the provided configuration options.

```APIDOC
## uqudoSdkFactory.create(options)

### Description
Creates and returns an instance of the uqudo SDK. This is the entry point for integrating uqudo services into your web application.

### Parameters
- **baseURL** (string) - Optional - Api base url provided by uqudo. Required only if your account is not associated with the default environment in Europe.
- **accessToken** (string) - Required - Authorization token.
- **nonce** (string) - Optional - Random string generated server-side to ensure the process was initiated by your application.
- **assets** (IAssetsArg) - Optional - List of assets for UI customization.
- **texts** (ITextsArg) - Optional - List of texts for UI customization.

### Example
```javascript
import uqudoSdkFactory from "uqudosdk-web";

const uqudoSdk = uqudoSdkFactory.create({
	accessToken: "your-access-token",
	nonce: "random-string-from-server"
});
```
```

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

### UqudoIdSDK.init()

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/react-native/enrolment-flow.md

Initializes the uqudo SDK. This should be called at the start-up of your application.

```APIDOC
## UqudoIdSDK.init()

### Description
Initializes the SDK instance. Call this method during application startup.

### Method
`new UqudoIdSDK().init()`
```

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

### JWS Header Structure

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/sdk-result/validation-and-parsing.md

Example of a JWS header containing the key identifier and algorithm.

```json
{
  "kid": "e49b9f971574455ba969b20697a2c7b6",
  "alg": "RS256"
}
```

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

### Initialize SDK in Objective-C

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/ios/usage.md

Perform SDK initialization within the application:didFinishLaunchingWithOptions: method in AppDelegate.m.

```objectivec
#import <UqudoSDK/UqudoSDK.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
   [[UQBuilderController alloc] init];  
	return YES;
}
```

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

### UqudoIdPlugin.init()

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/flutter/face-session-flow.md

Initializes the uqudo SDK at the start-up of your application.

```APIDOC
## UqudoIdPlugin.init()

### Description
Initializes the uqudo SDK. This should be called at the start-up of your application.

### Method
`UqudoIdPlugin.init()`
```

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

### Initiate Face Session

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/flutter/face-session-flow.md

Configure and start the face session process using the FaceSessionConfigurationBuilder.

```dart
import 'package:uqudosdk_flutter/UqudoIdPlugin.dart';
import 'package:uqudosdk_flutter/uqudosdk_flutter.dart';
...

String result;
var token = "<please put your token here>";
try {
   var faceSessionConfiguration = new FaceSessionConfigurationBuilder()
	.setToken(token)
	.setSessionId("<your session identifier>")
      .setAppearanceMode(AppearanceMode.SYSTEM)
	.build();
   result = await UqudoIdPlugin.faceSession(faceSessionConfiguration);
} catch (error) {
}
```

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

### Initialize the SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/capacitor/enrolment-flow.md

Call this method during application startup to initialize the uqudo plugin.

```javascript
import * as UqudoSDK from 'uqudosdk-capacitor';

...
//On App startup
new UqudoSDK.UqudoPlugin().init();
...
```

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

### GET /api/v1/info/{sessionId}

Source: https://docs.uqudo.com/docs/kyc/uqudo-api/info.md

Retrieves the final result of an SDK session using the session ID.

```APIDOC
## GET /api/v1/info/{sessionId}

### Description
Retrieves the final result of the SDK session. Note that this is typically not required as the SDK returns this result directly.

### Method
GET

### Endpoint
/api/v1/info/{sessionId}

### Parameters
#### Path Parameters
- **sessionId** (string) - Required - The unique identifier for the session.
```

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

### IO.Uqudo.Sdk.Core.UqudoSDK.Init(this)

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/lookup-flow.md

Initializes the uqudo SDK for Android applications.

```APIDOC
## Method: IO.Uqudo.Sdk.Core.UqudoSDK.Init

### Description
Initializes the uqudo SDK at the start-up of an Android application.

### Signature
`public static void Init(Context context)`
```

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

### UqudoSDK.init(context, tracer)

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/analytics.md

Initializes the Uqudo SDK with a custom tracer implementation to capture analytics events.

```APIDOC
## UqudoSDK.init

### Description
Initializes the Uqudo SDK and registers a tracer object to receive analytics events during the SDK lifecycle.

### Method
Kotlin SDK Method

### Parameters
- **applicationContext** (Context) - Required - The Android application context.
- **tracer** (Tracer) - Required - An implementation of the Tracer interface to handle trace events.

### Example
```kotlin
class App: Application() {
	override fun onCreate() {
		super.onCreate()
		UqudoSDK.init(applicationContext, TracerObject)
	}

	private object TracerObject : Tracer {
		override fun trace(trace: Trace) {
			Logger.d("---Analytics", trace.toString())
		}
	}
}
```
```

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

### OAuth2 Token Response Examples

Source: https://docs.uqudo.com/docs/kyc/uqudo-api/authorisation.md

Displays the JSON structure for successful and unauthorized token request responses.

```javascript
{
  "access_token": "JWS authorization token",
  "token_type": "bearer",
  "expires_in": 1800,
  "scope": "scopes",
  "jti": "30a622fd-11aa-464a-8eaf-6fa868540cb0"
}
```

```javascript
{
    // Response
}
```

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

### Initialize Uqudo SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/face-session-flow.md

Call this method during application initialization to set up the SDK.

```kotlin
UqudoSDK.init(applicationContext)
```

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

### Initialize iOS SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/enrolment-flow.md

Instantiate UQBuilderController within the FinishedLaunching method of the AppDelegate class.

```csharp
using UqudoSDK;
...
{
[Register("AppDelegate")]
public class AppDelegate : UIResponder, IUIApplicationDelegate
...
[Export("application:didFinishLaunchingWithOptions:")]
public bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
  new UQBuilderController();
  return true;
}
```

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

### Initiate Lookup Flow

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/flutter/lookup-flow.md

Configure and start the lookup flow, including optional facial recognition and background checks.

```dart
String result;
try {
  var lookupConfiguration = LookupBuilder()
	.setToken(token)
	.setDocumentType(DocumentType.NGA_DL)
	.enableFacialRecognition(
		new FacialRecognitionConfigurationBuilder()
			.setLookupMinimumMatchLevel(4)
			.build()
	)
	.enableBackgroundCheck(
		new BackgroundCheckConfigurationBuilder()
			.skipView()
			.build()
	)
	.build();
   result = await UqudoIdPlugin.lookup(lookupConfiguration);
} on PlatformException catch (exception) {
   result = exception.code;
   // {"code":"USER_CANCEL","message":"User canceled the Enrollment process","task":"LOOKUP"}
}
```

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

### Initialize Android SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/enrolment-flow.md

Call this method at the application start-up to initialize the Android SDK.

```csharp
IO.Uqudo.Sdk.Core.UqudoSDK.Init(this);
```

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

### cordova.plugins.UqudoIdPlugin.init

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/cordova/lookup-flow.md

Initializes the Uqudo SDK at application startup.

```APIDOC
## cordova.plugins.UqudoIdPlugin.init(traceCallback)

### Description
Initializes the Uqudo SDK. This should be called at the start-up of the application.

### Parameters
- **traceCallback** (Function) - Required - A callback function to handle trace logs.
```

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

### Initiate Lookup Flow

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/lookup-flow.md

Use the UqudoBuilder to configure and launch the Lookup Flow, including optional facial recognition and background check settings.

```kotlin
try {
   val uqudoIntent = UqudoBuilder.Lookup()
            .setToken(authorizationToken)
            .setDocumentType(DocumentType.NGA_DL)
            .enableFacialRecognition(
                     FacialRecognitionConfigurationBuilder()
                              .setLookupMinimumMatchLevel(4)
                              .build()
            )
            .enableBackgroundCheck(
                     BackgroundCheckConfigurationBuilder()
                              .skipView()
                              .build()
            )
            .build(this)
        startActivityForResult(uqudoIntent, 101)
} catch( e: Exception ){
    ...
}
```

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

### Initiate Android Lookup Flow

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/lookup-flow.md

Configure and start the lookup flow, including optional facial recognition and background checks.

```csharp
var uqudoLookupBuilder = new IO.Uqudo.Sdk.Core.UqudoBuilder.Lookup();
bool isLookupFacialRecognitionSupported = IO.Uqudo.Sdk.Core.Domain.Model.DocumentType.NgaVoterId.LookupFacialRecognitionSupported;

if (isLookupFacialRecognitionSupported)
{
    var facialRecognitionConfigurationBuilder = new IO.Uqudo.Sdk.Core.Builder.FacialRecognitionConfigurationBuilder();
    facialRecognitionConfigurationBuilder.SetLookupMinimumMatchLevel(4);
    uqudoLookupBuilder.EnableFacialRecognition(facialRecognitionConfigurationBuilder.Build());
}

var backgroundCheck = new IO.Uqudo.Sdk.Core.Builder.BackgroundCheckConfigurationBuilder();
backgroundCheck.SetBackgroundCheckType(IO.Uqudo.Sdk.Core.Domain.Model.BackgroundCheckType.Rdc);
uqudoLookupBuilder.EnableBackgroundCheck(backgroundCheck.Build());
uqudoLookupBuilder.SetToken(token);
uqudoLookupBuilder.SetDocumentType(IO.Uqudo.Sdk.Core.Domain.Model.DocumentType.NgaNin);

StartActivityForResult(uqudoLookupBuilder.Build(this), 101);
```

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

### Import Uqudo SDK

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/javascript-usage.md

Include the SDK in your project by adding the script tag to your HTML.

```javascript
<script type="text/javascript" src="./index.js"></script>
```

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

### Android SDK Initialization

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/enrolment-flow.md

Initializes the uqudo SDK at the start-up of the Android application.

```APIDOC
## IO.Uqudo.Sdk.Core.UqudoSDK.Init

### Description
Initializes the uqudo SDK at the start-up of the application.

### Method
Static Method

### Parameters
- **context** (this) - Required - The current application context.
```

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

### Install uqudo React Native plugin

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/react-native/plugin-installation.md

Run this command in the root of your React Native project to add the uqudo SDK dependency.

```shell
npm install uqudosdk-react-native --save
```

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

### Initialize iOS SDK with Tracer

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/analytics.md

Inject the tracer instance into the UQBuilderController during application launch.

```csharp
[Export("application:didFinishLaunchingWithOptions:")]
public bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
    var tracer = new Tracer();
    new UQBuilderController(trace: tracer);
    return true;
}
```

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

### Initialize Face Session

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/web/face-session-flow.md

Use the faceSession method to start the facial recognition process with the required session ID and optional configuration callbacks.

```javascript
try {
  const result = uqudoSdk.faceSession({
     	sessionId: string;
     	returnDataForIncompleteSession?: boolean;
     	maxAttempts?: number;
     	minimumMatchLevel?: number;
    	onSuccess?: (result) => {
	  // Result returned after a successful face session
	  console.log(result)
	};
	onError?: (error) => {
	  // Error returned from the face session process failure 
	  console.log(error)
	};
	onTrace?: (trace) => {
	  // trace events
	  console.log(trace)
	};
    	onFinally?: () => void;
     	assets?: IAssetsArg;
     	texts?: ITextsArg;
  });
} catch (error) {
}
```

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

### Add SDK Dependency and Build Options

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/android/prepare-environment.md

Configure Java compatibility, ABI splits, and the Uqudo SDK dependency in the application build file.

```groovy
android {
      compileOptions {
            sourceCompatibility JavaVersion.VERSION_17 
            targetCompatibility JavaVersion.VERSION_17
      }
      splits {
            abi {
                  enable true
                  universalApk false
            }
      }
}
dependencies {
      implementation 'io.uqudo.sdk:Uqudo:3.9.0'
}
```

```kotlin
android {
    compileOptions {
        sourceCompatibility(JavaVersion.VERSION_17)
        targetCompatibility(JavaVersion.VERSION_17)
    }
    splits {
        abi {
            isEnable = true
            isUniversalApk = false
        }
    }
}

dependencies {
    implementation("io.uqudo.sdk:Uqudo:3.9.0")
}
```

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

### Initiate Scan Request with curl

Source: https://docs.uqudo.com/docs/kyc/uqudo-api/scan.md

Example command to perform a document scan using curl. Replace the URL with the actual API server base URL.

```bash
$ curl -v \
-H 'Authorization: Bearer token' \
https://example.com/api/v1/scan \
-F documentType=UAE_ID \
-F frontImage=@/front.jpg \
-F backImage=@/back.jpg
```

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

### Initiate Android Enrolment Process

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/dotnet/enrolment-flow.md

Configures passport reading with NFC and facial recognition, then starts the activity. Use OnActivityResult to handle the returned JWS result.

```csharp
var uqudoEnrollmentBuilder = new IO.Uqudo.Sdk.Core.UqudoBuilder.Enrollment();
var documentBuilder = new IO.Uqudo.Sdk.Core.DocumentBuilder(this);
documentBuilder.SetDocumentType(IO.Uqudo.Sdk.Core.Domain.Model.DocumentType.Passport);
var readingConfiguration = new IO.Uqudo.Sdk.Core.Builder.ReadingConfigurationBuilder();
documentBuilder.EnableReading(readingConfiguration.Build());
var facialRecognitionConfigurationBuilder = new IO.Uqudo.Sdk.Core.Builder.FacialRecognitionConfigurationBuilder();
uqudoEnrollmentBuilder.EnableFacialRecognition(facialRecognitionConfigurationBuilder.Build());
uqudoEnrollmentBuilder.SetToken("<YOUR_AUTHORIZATION_TOKEN_HERE>");
uqudoEnrollmentBuilder.Add(documentBuilder.Build());
StartActivityForResult(uqudoEnrollmentBuilder.Build(this), 100);

...
protected override void OnActivityResult(int requestCode, [GeneratedEnum] Result resultCode, Intent data) {
   base.OnActivityResult(requestCode, resultCode, data);
   if (requestCode == 100) {
 	Console.WriteLine("JWS result" + data.GetStringExtra("data"));
   }
}
```

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

### Initialize SDK in Swift

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/ios/usage.md

Configure the Bridging Header and initialize the SDK in AppDelegate.swift.

```swift
#import <UqudoSDK/UqudoSDK.h>
```

```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
	UQBuilderController()
	return true
}
```

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

### UqudoIdSDK.enroll(configuration)

Source: https://docs.uqudo.com/docs/kyc/uqudo-sdk/integration/react-native/enrolment-flow.md

Initiates the enrolment process using a configured EnrollmentBuilder.

```APIDOC
## UqudoIdSDK.enroll(configuration)

### Description
Starts the enrolment process. Returns a JWS on success or throws an error object on failure.

### Parameters
- **configuration** (EnrollmentBuilder) - Required - The configuration object built via EnrollmentBuilder.
```
Tokens:
Raw