Identomat

https://docs.identomat.com
Admin
Identomat is an ID verification and KYC/AML platform offering identity document verification,...
Tokens:83,597
Snippets:785
Trust Score:7.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start Default Session (JSON)

Source: https://docs.identomat.com/developer-tools/api-reference

Initiates a default verification session. Requires only the company key. This is a basic setup without specific configurations or custom steps.

```json
{
  "company_key": "your-company-secret-key"
}
```

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

### Identomat Flutter SDK Example Usage

Source: https://docs.identomat.com/sdks/flutter-sdk

This example demonstrates how to initialize the Identomat SDK, set configuration options like base URL, colors, and strings, and start a verification session with a provided session key.

```dart
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:identomat_flutter/identomat.dart';
import 'package:identomat_flutter_example/data.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final identomat = Identomat();
  TextEditingController myController = TextEditingController();
  final formKey = GlobalKey<FormState>();

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState(String sesstionKey) async {
    identomat.setCallback(
      () {
        print('===========>>> ONCALL');
      },
    );
    await identomat.setBaseUrl(data['baseUrl']);
    await identomat.setColors(data['colors']);
    await identomat.setStrings(data['strings']);
    await identomat.start(sesstionKey);
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Padding(
            padding: const EdgeInsets.all(16),
            child: Form(
              key: formKey,
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  TextFormField(
                    controller: myController,
                    decoration:
                        const InputDecoration(hintText: 'Enter session key'),
                    validator: (text) {
                      if (text == null || text.trim().isEmpty) {
                        return 'Session key is empty';
                      }
                      return null;
                    },
                  ),
                  const SizedBox(
                    height: 20,
                  ),
                  ElevatedButton(
                    onPressed: () {
                      FocusManager.instance.primaryFocus?.unfocus();
                      if (formKey.currentState!.validate()) {
                        initPlatformState(myController.text.trim());
                      }
                    },
                    child: const Text('Click'),
                  ),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }
}

```

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

### Full KYB Radio Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

An example demonstrating a complete radio question configuration, including all parameters.

```json
"questions": [
    {
        "type": "options",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question3",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "answer": "identity-document",
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            },
            "readOnly": true
        }
    ]
]
```

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

### KYB File Upload Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

An example of a complete file upload question configuration within the 'questions' array.

```json
"questions": [
    {
        "type": "file",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question5",
            "mandatory": true,
            "fileTypes": [
            "pdf",
            "image"
            ],
            "filesMaxCount": 5,
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            }
        }
    ]

```

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

### Short Answer Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

An example configuration for a short answer KYC question, including title, key, format, and conditional display.

```json
"questions": [
    {
        "type": "string",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question1",
        "mandatory": true,
        "format": {
            "email"
            },
        "answer": {
            "en": "This is a prefilled answer",
            "es": "Esta es una respuesta prellenada."
        },
        "showConditions": {
            "questionKey": "question1",
            "answer": "option1"
        },
        "readOnly": false
    }
]
```

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

### Full Radio Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

A complete example of a radio question configuration, including all available parameters.

```json
"questions": [
    {
        "type": "options",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question3",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "answer": "identity-document",
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            },
            "readOnly": true
        }
    ]
}
```

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

### Get Session Configuration Default Result

Source: https://docs.identomat.com/developer-tools/api-reference

Example of a successful response when retrieving session configuration details. It includes the configuration ID, name, general settings, and a list of steps.

```json
{
  "result": {
    "id": "679c74e4d9725987e3879265",
    "name": "Configuration Template",
    "general": {
        "language": "en",
        "sessionLifetime": 15
        },
    "steps": [
      {
        "title": {
          "en": "ID Verification"
        },
        "type": "identity-document",
        "key": "select_document_id",
        "flags": {
          "documentTypes": [
            "id",
            "passport",
            "driver_license",
            "residence_permit"
          ]
        }
      },
      {
        "title": {
          "en": "Liveness Check"
        },
        "type": "liveness",
        "key": "liveness",
        "flags": {
          "liveness": true,
          "maxLivenessAttempts": 3
        }
      }
    ]
  }
}
```

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

### Full Attachment Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

An example of a complete 'attachment' question configuration within a 'questions' array, including all relevant parameters.

```json
"questions": [
    {
        "type": "attachment",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "description": {
            "es": "Tu descripción",
            "en": "Your description"
            },
        "key": "question5",
        "fileTypes": [
            "pdf",
            "image"
            ],
        "filesMaxCount": 5,
        "allowOperatorUpload": true,
        "allowOperatorOverride": true,
        "answer": [ ],
        "showConditions": {
            "questionKey": "question1",
            "answer": "option1"
            }
        }
    ]

```

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

### Setup Session Token and Callback

Source: https://docs.identomat.com/sdks/android-sdk

Configure the SDK with a session token and set up a callback for completion.

```APIDOC
## Setup Session Token and Callback

### Description
Configure the Identomat SDK with a session token obtained from the API and set a callback function to handle the completion of the user identification flow.

### Method
```kotlin
IdentomatManager.INSTANCE.setUp(token: String)
IdentomatManager.INSTANCE.setCallback(callback: () -> Unit)
```

### Parameters
#### `setUp` function:
- **token** (String) - Required - The session token obtained from the `begin/` endpoint.

#### `setCallback` function:
- **callback** (Function) - Required - A function to be executed after the user completes the identification process.

### Usage Example (Kotlin)
```kotlin
val sessionToken = "YOUR_SESSION_TOKEN"
IdentomatManager.INSTANCE.setUp(token = sessionToken)
IdentomatManager.INSTANCE.setCallback {
    // Handle completion, e.g., navigate to a result page
    println("Identomat flow completed")
}
```

### Usage Example (Java)
```java
String sessionToken = "YOUR_SESSION_TOKEN";
IdentomatManager.INSTANCE.setUp(sessionToken);
IdentomatManager.INSTANCE.setCallback(() -> {
    // Handle completion, e.g., navigate to a result page
    System.out.println("Identomat flow completed");
});
```
```

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

### Short Answer Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

A complete example of a short answer question configuration, including title, key, mandatory status, prefilled answer, display conditions, and read-only setting.

```json
"questions": [
    {
        "type": "string",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question1",
        "mandatory": true,
        "answer": {
            "en": "This is a prefilled answer",
            "es": "Esta es una respuesta prellenada."
        },
        "showConditions": {
            "questionKey": "question1",
            "answer": "option1"
        },
        "readOnly": true
    }
]
```

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

### Query Documentation with GET Request

Source: https://docs.identomat.com/get-started/user-roles-overview/receiving-calls

To get additional information not present on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.identomat.com/get-started/user-roles-overview/receiving-calls.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://docs.identomat.com/get-started/api-access

To get additional information not present on the current page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.identomat.com/get-started/api-access.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.identomat.com/sdks/react-native-sdk/react-native-sdk-changelog

Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve specific information not explicitly present or to get clarification.

```http
GET https://docs.identomat.com/sdks/react-native-sdk/react-native-sdk-changelog.md?ask=<question>
```

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

### Setup Session Token

Source: https://docs.identomat.com/sdks/ios-sdk

Configure the SDK with the session token obtained from the Identomat API.

```APIDOC
## Setup Session Token

### Description
Initialize the SDK with a session token. This token is required to start the verification process.

### Method
`func setUp(token: String)`

### Parameters
#### Request Body
- **token** (String) - Required - The session token obtained from the Identomat API.
```

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

### Full Checkbox Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

An example of a complete 'multiple-choice' question configuration, including all available parameters like title, options, mandatory, answer, showConditions, and readOnly.

```json
"questions": [
    {
        "type": "multiple-choice",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question2",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "answer": [
                "identity-document",
                "proof-of-address"
            },
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            },
            "readOnly": true
        }
    ]
}
```

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

### Blacklist Entry Example

Source: https://docs.identomat.com/developer-tools/api-reference

Example structure for a blacklist entry, including personal details and reasons for blacklisting.

```json
{
    "lastName": "Doe",
    "documentNumber": "123ABC123",
    "personalNumber": "012345678901",
    "birthday": "1980-01-01T00:00:00.000Z",
    "notes": "Fraud-related activity",
    "reason": "Reason for adding to blacklist",
    "id": "64f4d0ec35f5bb20a8022012"
}
```

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

### Email Verification

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

This example demonstrates how to set up an email verification step, allowing for OTP verification or simple email collection.

```APIDOC
## POST /external-api/begin/

### Description
Initiates a KYC process that includes an email verification or collection step.

### Method
POST

### Endpoint
https://widget.identomat.com/external-api/begin/

### Parameters
#### Request Body
- **company_key** (string) - Required - Your company's unique key.
- **flags** (object) - Optional - Flags to control the verification flow.
  - **return_url** (string) - Optional - The URL to redirect the user to after completion.
  - **language** (string) - Optional - The language code for the user interface.
- **steps** (array) - Required - An array of steps to be included in the KYC process.
  - **title** (object) - Optional - Titles for the step in different languages.
  - **type** (string) - Required - The type of step, "email".
  - **key** (string) - Required - A unique key for the step.
  - **flags** (object) - Optional - Flags specific to the email step.
    - **require_email_check** (boolean) - Optional - Requires email verification via an OTP code. Defaults to `false`.
    - **require_email** (boolean) - Optional - Requires users to submit an email without verification. Defaults to `false`.

### Request Example
```json
{
  "company_key": "your_company_key_here",
  "flags": {
    "return_url": "https://example.com/",
    "language": "en"
  },
  "steps": [
    {
      "title": {
        "en": "Email verification"
      },
      "type": "email",
      "key": "require_email",
      "flags": {
        "require_email_check": true
      }
    }
  ]
}
```
```

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

### Query Documentation with GET Request

Source: https://docs.identomat.com/introduction

Use this method to dynamically query the documentation. Perform an HTTP GET request on the current page URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.identomat.com/introduction.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.identomat.com/developer-tools/developer-guide

To get information not explicitly present on the page, perform an HTTP GET request with an 'ask' query parameter. The response will include answers and relevant documentation excerpts.

```http
GET https://docs.identomat.com/developer-tools/developer-guide.md?ask=<question>
```

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

### cURL Example: Identity Document and Active Liveness Verification

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

This example demonstrates how to initiate a KYC process using cURL, including identity document verification and an active liveness check. It specifies supported document types and countries, along with the language for the user interface.

```bash
curl https://widget.identomat.com/external-api/begin/ -d '{
    "company_key": "your_company_key_here",
    "flags": {
        "language": "en"
    },
    "steps": [
        {
            "title": {
                "en": "ID verification"
                },
            "type": "identity-document",
            "key": "select_document_id",
            "flags": {
                "allow_document_upload": true,
                "document_types": [
                    "id",
                    "passport",
                    "driver_license",
                    "residence_license"
                ],
                "document_countries": [
                    "USA",
                    "FRA"
                ]
            }
        },
        {
            "title": {
                "en": "Liveness check"
                },
            "type": "liveness",
            "key": "liveness",
            "flags": {
                "liveness": true
            }
        }
    ] 
}'
```

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

### Query Documentation with HTTP GET

Source: https://docs.identomat.com/get-started

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and self-contained. Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections.

```http
GET https://docs.identomat.com/get-started.md?ask=<question>
```

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

### Full Dropdown Question Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

An example demonstrating the structure of a complete dropdown question, including type, title, key, options, mandatory flag, multiple choice flag, and show conditions.

```json
"questions": [
    {
        "type": "options",
        "title": {
            "es": "Tu título",
            "en": "Your title"
        },
        "key": "question4",
        "options": [
            {
                "title": {
                    "en": "Identity Document",
                    "es": "Documento de identidad"
                },
                "key": "identity-document"
            },
            {
                "title": {
                    "en": "Proof of Address",
                    "es": "Comprobante de domicilio"
                },
                "key": "proof-of-address"
            ],
            "mandatory": true,
            "multiple": true,
            "showConditions": {
                "questionKey": "question1",
                "answer": "option1"
            }
        }
    ]
]
```

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

### Query Documentation via HTTP GET

Source: https://docs.identomat.com/developer-tools

Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to dynamically query for information. The question should be specific and in natural language. Use this for answers not explicitly present, clarifications, or related sections.

```HTTP
GET https://docs.identomat.com/developer-tools.md?ask=<question>
```

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

### Query Documentation with `ask` Parameter

Source: https://docs.identomat.com/no-code-workflows

Perform an HTTP GET request to query documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language to get direct answers and relevant excerpts.

```HTTP
GET https://docs.identomat.com/no-code-workflows.md?ask=<question>
```

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

### Start Identomat SDK Activity

Source: https://docs.identomat.com/sdks/android-sdk

Obtain the Intent for the SDK's main activity and start it to initiate the identification process. Requires the current Activity context.

```java
startActivity(IdentomatManager.INSTANCE.getIdentomatActivity(MainActivity.this));
```

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

### Query Documentation Dynamically

Source: https://docs.identomat.com/get-started/user-roles-overview

To get information not explicitly on the current page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.identomat.com/get-started/user-roles-overview.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

Perform an HTTP GET request to query documentation dynamically. Use the 'ask' query parameter with a specific, natural language question to get direct answers and relevant excerpts.

```HTTP
GET https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer.md?ask=<question>
```

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

### Querying Documentation Dynamically

Source: https://docs.identomat.com/developer-tools/developer-guide/callbacks

To get information not explicitly present on the page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.identomat.com/developer-tools/developer-guide/callbacks.md?ask=<question>
```

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

### Start Identomat SDK Activity

Source: https://docs.identomat.com/sdks/android-sdk

Launch the main activity of the Identomat SDK.

```APIDOC
## Start Identomat SDK Activity

### Description
Obtain the `Intent` for the Identomat SDK's main activity and start it to initiate the user identification flow.

### Method
```kotlin
IdentomatManager.INSTANCE.getIdentomatActivity(context: Context): Intent
```

### Parameters
- **context** (Context) - Required - The current Android context.

### Usage Example (Kotlin)
```kotlin
val intent = IdentomatManager.INSTANCE.getIdentomatActivity(this)
startActivity(intent)
```

### Usage Example (Java)
```java
Intent intent = IdentomatManager.INSTANCE.getIdentomatActivity(this);
startActivity(intent);
```
```

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

### Start Identomat SDK

Source: https://docs.identomat.com/sdks/ios-sdk

Obtain the SDK's view and present it to the user to initiate the identification process.

```APIDOC
## Start Identomat SDK

### Description
Retrieve the `IdentomatView` and present it to the user to begin the identification flow. Ensure the view is presented modally with a full-screen style.

### Method
`func getIdentomatView() -> UIViewController`

### Code Example
```swift
let identomatView = IdentomatManager.getInstance().getIdentomatView()
identomatView.modalPresentationStyle = .fullScreen
self.present(identomatView, animated: true, completion: nil) // self is UIViewController type class
```
```

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

### KYC Question Answer Preset Example

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

Pre-set an answer for a question, which can be a string or an array.

```json
"answer": "option2"
```

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

### Geolocation

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

This example shows how to configure a geolocation step to request the user's location data.

```APIDOC
## POST /external-api/begin/

### Description
Initiates a KYC process that includes a geolocation step to request the user's location data.

### Method
POST

### Endpoint
https://widget.identomat.com/external-api/begin/

### Parameters
#### Request Body
- **company_key** (string) - Required - Your company's unique key.
- **flags** (object) - Optional - Flags to control the verification flow.
  - **return_url** (string) - Optional - The URL to redirect the user to after completion.
  - **language** (string) - Optional - The language code for the user interface.
- **steps** (array) - Required - An array of steps to be included in the KYC process.
  - **type** (string) - Required - The type of step, "geolocation".
  - **key** (string) - Required - A unique key for the step.
  - **flags** (object) - Optional - Flags specific to the geolocation step.
    - **require_geolocation** (boolean) - Optional - Requires location access to proceed through the step. Defaults to `true`.

### Request Example
```json
{
  "company_key": "your_company_key_here",
  "flags": {
    "return_url": "https://example.com/",
    "language": "en"
  },
  "steps": [
    {
      "type": "geolocation",
      "key": "require_geolocation",
      "flags": {
        "require_geolocation": true
      }
    }
  ]
}
```
```

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

### Initiate KYC Process with Language Selection

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

Example of initiating the KYC process using the external API, specifying company key, return URL, and configuring the language step with multiple language options.

```bash
curl https://widget.identomat.com/external-api/begin/ -d '{
    "company_key": "your_company_key_here",
    "flags": {
        "return_url": "https://example.com/",
        "language": "es"
    } ,
    "steps": [
     {
                "title": {
                  "en": "Language",
                  "ka": "ენა",
                  "es": "Idioma",
                  "uk": "Мова",
                  "gr": "Γλώσσα",
                  "it": "Lingua",
                  "de": "Sprache",
                  "ru": "Язык",
                  "uz": "Til",
                  "ro": "Limbă",
                  "tr": "Dil",
                  "ar": "اللغة",
                  "pl": "Język",
                  "bn": "ভাষা",
                  "hi": "भाषा",
                  "hy": "Լեզու",
                  "az": "Dil",
                  "ja": "言語",
                  "pt": "Idioma",
                  "fr": "Langue",
                  "kk": "Тіл",
                  "sv": "Språk"
                },
                "type": "language",
                "key": "language",
                "languages": [
                    "en",
                    "ka",
                    "es",
                    "uk",
                    "gr",
                    "it",
                    "de",
                    "ru",
                    "uz",
                    "ro",
                    "tr",
                    "ar",
                    "pl",
                    "bn",
                    "hi",
                    "hy",
                    "az",
                    "ja",
                    "pt",
                    "fr",
                    "kk",
                    "sv"
                ]
            },
            {
                "title": {
                  "en": "ID verification",
                  "ka": "პირადობის დადასტურება",
                  "es": "Verificación de identidad",
                  "uk": "Підтвердження особи",
                  "gr": "Επαλήθευση ταυτότητας",
                  "it": "Verifica dell identità",
                  "de": "Identitätsprüfung",
                  "ru": "Проверка удостоверения личности",
                  "uz": "Shaxsni tasdiqlash",
                  "ro": "Verificare a identității",
                  "tr": "Kimlik doğrulama",
                  "ar": "التحقق من الهوية",
                  "pl": "Weryfikacja tożsamości",
                  "bn": "পরিচয় যাচাই",
                  "hi": "पहचान सत्यापन",
                  "hy": "Անձնագրի հաստատում",
                  "az": "Şəxsiyyətin təsdiqi",
                  "ja": "本人確認",
                  "pt": "Verificação de identidade",
                  "fr": "Vérification d identité",
                  "kk": "Жеке басын тексеру",
                  "sv": "ID-verifiering"
            },
                "type": "identity-document",
                "key": "select_document_id-1",
                "flags": {
                    "document_types": [
                        "id",
                        "passport",
                        "driver_license",
                        "residence_license"
                    ],
                    "allow_document_upload": false,
                    "disable_document_capture": false
                }
            }
    ]
}'
```

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

### Start Session with Configuration (JSON)

Source: https://docs.identomat.com/developer-tools/api-reference

Initiates a verification session using a specified configuration ID. This is the recommended method for flexibility and ease of use.

```json
{
  "company_key": "your-company-secret-key",
  "config_id": "62412c096c4b39ba845d4bf2"
}
```

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

### Get Document Visual Markers cURL Example

Source: https://docs.identomat.com/developer-tools/api-reference

Use this cURL command to send a POST request to the get-visual-markers endpoint. Ensure you replace placeholders with your actual company key and session ID.

```bash
curl -X POST 'https://external-api.identomat.com/get-visual-markers' \
    -H 'Content-Type: application/json' \
    -d '{
    "companyKey": "your-company-secret-key",
    "sessionId": "example-session-id-12345"
}'
```

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

### Get Question File cURL Example

Source: https://docs.identomat.com/developer-tools/api-reference

Use this cURL command to retrieve a file associated with a specific question in a questionnaire. Provide your company key, session ID, step key, question key, and optionally the file index.

```bash
curl -X POST 'https://external-api.identomat.com/get-question-file' \
    -H 'Content-Type: application/json' \
    -d '{
        "companyKey": "your-company-secret-key",
        "sessionId": "example-session-id-12345",
        "stepKey": "user-questionnaire-1",
        "questionKey": "question-1",
        "fileIndex": 0
}'
```

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

### Initiate KYB Process with Language Selection

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

Example of initiating the KYB process using the external API, including company key, return URL, and step configurations for language and ID verification.

```bash
curl https://widget.identomat.com/external-api/begin/ -d '{
    "company_key": "your_company_key_here",
    "flags": {
        "return_url": "https://example.com/",
        "language": "es"
    } ,
    "steps": [
     {
                "title": {
                  "en": "Language",
                  "ka": "ენა",
                  "es": "Idioma",
                  "uk": "Мова",
                  "gr": "Γλώσσα",
                  "it": "Lingua",
                  "de": "Sprache",
                  "ru": "Язык",
                  "uz": "Til",
                  "ro": "Limbă",
                  "tr": "Dil",
                  "ar": "اللغة",
                  "pl": "Język",
                  "bn": "ভাষা",
                  "hi": "भाषा",
                  "hy": "Լեզու",
                  "az": "Dil",
                  "ja": "言語",
                  "pt": "Idioma",
                  "fr": "Langue",
                  "kk": "Тіл",
                  "sv": "Språk"
                },
                "type": "language",
                "key": "language",
                "languages": [
                    "en",
                    "ka",
                    "es",
                    "uk",
                    "gr",
                    "it",
                    "de",
                    "ru",
                    "uz",
                    "ro",
                    "tr",
                    "ar",
                    "pl",
                    "bn",
                    "hi",
                    "hy",
                    "az",
                    "ja",
                    "pt",
                    "fr",
                    "kk",
                    "sv"
                ]
            },
            {
                "title": {
                  "en": "ID verification",
                  "ka": "პირადობის დადასტურება",
                  "es": "Verificación de identidad",
                  "uk": "Підтвердження особи",
                  "gr": "Επαλήθευση ταυτότητας",
                  "it": "Verifica dell'identità",
                  "de": "Identitätsprüfung",
                  "ru": "Проверка удостоверения личности",
                  "uz": "Shaxsni tasdiqlash",
                  "ro": "Verificare a identității",
                  "tr": "Kimlik doğrulama",
                  "ar": "التحقق من الهوية",
                  "pl": "Weryfikacja tożsamości",
                  "bn": "পরিচয় যাচাই",
                  "hi": "पहचान सत्यापन",
                  "hy": "Անձնագրի հաստատում",
                  "az": "Şəxsiyyətin təsdiqi",
                  "ja": "本人確認",
                  "pt": "Verificação de identidade",
                  "fr": "Vérification d'identité",
                  "kk": "Жеке басын тексеру",
                  "sv": "ID-verifiering"
            },
                "type": "identity-document",
                "key": "select_document_id-1",
                "flags": {
                    "document_types": [
                        "id",
                        "passport",
                        "driver_license",
                        "residence_license"
                    ],
                    "allow_document_upload": false,
                    "disable_document_capture": false
                }
            }
    ]
}'
```

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

### cURL Example with Return URL, Language, and Geolocation

Source: https://docs.identomat.com/developer-tools/developer-guide/kyc-know-your-customer

Use this cURL command to initiate a KYC verification flow with specified return URL, language, and a mandatory geolocation step. Replace 'your_company_key_here' with your actual company key.

```bash
curl https://widget.identomat.com/external-api/begin/ -d '{
"company_key": "your_company_key_here",
"flags": {
        "return_url": "https://example.com/",
        "language": "en"
},
"steps": [
    {
        "title": {
            "en": "Geolocation"
            },
        "type": "geolocation",
        "key": "require_geolocation",
        "flags": {
            "require_geolocation": true
        }
    }
]   
}'
```

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

### Install React Native SDK

Source: https://docs.identomat.com/sdks/react-native-sdk

Install the SDK using npm. For iOS, ensure you run `pod-install` in your iOS directory.

```bash
npm install '@identomat-inc/react-native-identomat'
```

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

### Initiate KYB Process with cURL

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

Example using cURL to initiate the Know Your Business (KYB) process via the external API. This includes company data fields and configurations for beneficiary roles like shareholder, UBO, director, representative, and other.

```bash
curl https://widget.identomat.com/external-api/begin/ -d '{
"company_key": "your_company_key_here",
"flags": {
        "return_url": "https://example.com/",
        "language": "en"
},
  "steps": [
        {
          "type": "company",
          "key": "company",
          "title": {
            "en": "Company data"
          },
          "description": {
            "en": "Follow the simple steps below"
          },
          "fields": [
               { "type": "companyName", "mandatory": true },
               { "type": "companyEntityType", "mandatory": false },
               { "type": "registrationNumber", "mandatory": true },
               { "type": "registrationCountry", "mandatory": true },
               { "type": "legalAddress", "mandatory": true },
               { "type": "taxId", "mandatory": false },
               { "type": "dateOfIncorporation", "mandatory": false },
               { "type": "contactNumber", "mandatory": false },
               { "type": "email", "mandatory": false }
          ]
        },
        {
          "type": "beneficiaries",
          "key": "beneficiaries",
          "title": {
            "en": "Beneficiaries"
          },
          "description": {
            "en": "Enter information about the company's beneficiaries"
          },
          "kycConfigId": "687e0ba12cf633bd323cb0db",
          "kybConfigId": "687e0ba12cf633bd323cb0d2",
          "roles": {
            "shareholder": {
              "fields": [
                  { "type": "ownershipPercentage", "mandatory": false },
                  { "type": "companyName", "mandatory": true },
                  { "type": "companyEntityType", "mandatory": false },
                  { "type": "registrationNumber", "mandatory": true },
                  { "type": "registrationCountry", "mandatory": true },
                  { "type": "legalAddress", "mandatory": false },
                  { "type": "taxId", "mandatory": false },
                  { "type": "dateOfIncorporation", "mandatory": false },
                  { "type": "firstName", "mandatory": true },
                  { "type": "lastName", "mandatory": true },
                  { "type": "dateOfBirth", "mandatory": true },
                  { "type": "contactNumber", "mandatory": false },
                  { "type": "email", "mandatory": false }, 
                  { "type": "website", "mandatory": false }
              ],
              "verification": true
            },
            "ubo": {
              "fields": [
                { "type": "ownershipPercentage", "mandatory": true },
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            },
            "director": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            },
            "representative": {
              "fields": [
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            },
            "other": {
              "fields": [
                { "type": "positionName", "mandatory": true },
                { "type": "firstName", "mandatory": true },
                { "type": "lastName", "mandatory": true },
                { "type": "dateOfBirth", "mandatory": true },
                { "type": "email", "mandatory": false },
                { "type": "contactNumber", "mandatory": false }
              ],
              "verification": true
            }
          }

```

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

### AML Screening Result Example

Source: https://docs.identomat.com/developer-tools/api-reference

A default example of an AML screening result for a person entity, detailing personal information and associated profiles.

```json
{
    "result": {
        "entityType": "person",
        "firstName": "John",
        "middleName": "Doe",
        "lastName": "Smith",
        "gender": "male",
        "birthdayTime": "1952-10-07",
        "nationality": "US",
        "extraDetails": [
            {
                "groupName": "Profile",
                "details": [
                    {
                        "detailName": "John Doe Smith",
                        "properties": [
                            {
                                "propertyName": "Position",
                                "value": [
                                    "President of US (2012-)",
                                    "chairperson",
                                    "party leader"
                                ],
                                "type": "list"
                            },
                            {
                                "propertyName": "Name",
                                "value": [
                                    "John Doe Smith",
                                    "约翰·多·史密斯",
                                    "Джон Доу Сміт",
                                    {
                                        "propertyName": "Alias",
                                        "value": [
                                            "John Smith"
                                        ],
                                        "type": "list"
                                    },
                                    {
                                        "groupName": "Position occupied",
                                        "details": [
                                            {
                                                "detailName": "President",
                                                "properties": [
                                                    {
                                                        "propertyName": "Name",
                                                        "value": [
                                                            "President of US",
                                                            "President"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    {
                                                        "propertyName": "Start Date",
                                                        "value": [
                                                            "1999-08-16"
                                                        ],
                                                        "type": "date"
                                                    },
                                                    {
                                                        "propertyName": "End Date",
                                                        "value": [
                                                            "2000-05-07"
                                                        ],
                                                        "type": "date"
                                                    },
                                                    {
                                                        "propertyName": "Status",
                                                        "value": [
                                                            "active"
                                                        ],
                                                        "type": "string"
                                                    }
                                                ]
                                            },
                                            {
                                                "groupName": "Sanctions",
                                                "details": [
                                                    {
                                                        "detailName": "Department of Foreign Affairs and Trade",
                                                        "properties": [
                                                            {
                                                                "propertyName": "Start Date",
                                                                "value": [
                                                                    "2022-02-28"
                                                                ],
                                                                "type": "date"
                                                            }
                                                        ]
                                                    }
                                                ]
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
```

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

### Initialize SDK with Session Token

Source: https://docs.identomat.com/sdks/android-sdk

Set up the Identomat SDK with the obtained session token. Ensure the token is a String.

```java
IdentomatManager.INSTANCE.setUp(token: sessionToken);
```

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

### Video Call Status Example

Source: https://docs.identomat.com/developer-tools/api-reference

This JSON snippet shows an example of the videoCallStatus array as it might appear in the /result endpoint, indicating a completed video call.

```json
"videoCallStatus": [
  {
    "roomId": "RM27b1b047ccc30c0519959d66b4f0689d",
    "roomStatus": "ended",
    "compositionStatus": "available",
    "videoFileStatus": "available",
    "videoFileId": "hlwXVfonxNogXujgqT9anl1EphgwNiXuy7ug96sH"
  }
]
```

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

### cURL: Begin KYB with User Questionnaire

Source: https://docs.identomat.com/developer-tools/developer-guide/kyb-know-your-business

Use this cURL command to start the KYB process by defining a user questionnaire. Customize company key, flags, and questionnaire steps with specific questions and options.

```bash
curl https://widget.identomat.com/external-api/begin/ -d '{
"company_key": "your_company_key_here",
"flags": {
        "restrict_url_sharing": true,
        "language": "es"
},
"steps": [
    {
            "key": "questionnaire-page-1",
            "type": "user-questionnaire",
            "title": {
                "es": "Tu título",
                "en": "Your title"
                },
            "description": {
                "es": "Tu descripción",
                "en": "Your description"
                },
            "questions": [
                {
                "type": "string",
                "title": {
                "es": "Tu título",
                "en": "Your title"
                },
                "key": "question1",
                "mandatory": true
                },
                {
                "type": "multiple-choice",
                "title": {
                "es": "Tu título",
                "en": "Your title"
                },
                "key": "question2",
                "mandatory": false,
                "options": [
                    {
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option1"
                    },
                    {
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option2"
                    }
                ],
                "answer": ["option2"],
                "readOnly": true
                },
                {
                "type": "options",
                "title": {
                "es": "Tu título",
                "en": "Your title"
                },
                "key": "question3",
                "mandatory": true,
                "options": [
                    {
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option3"
                    },
                    {
                    "title": {
                    "es": "Tu título",
                    "en": "Your title"
                    },
                    "key": "option4"
                    }
                ]
            }
        ]
    }
]
}'
```

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

### Initialize and Start Identomat SDK

Source: https://docs.identomat.com/sdks/react-native-sdk

Import and configure the SDK with callbacks, base URL, colors, strings, and session key. The `setCallback` and `setBackButtonCallback` methods are used to handle process completion and back button presses, respectively.

```javascript
     import identomat from '@identomat-inc/react-native-identomat';
// Callback for when the process finishes
    class Callback {
        callback() {
        console.log('finished')
        }
    }

// Callback for back button
class Back {
    callback() {
      console.log('back')
    
    }
  }
    identomat.setCallback(new Callback());
    identomat.setBackButtonCallback(new Back());
    identomat.setBaseUrl(config.baseUrl);
    identomat.setColors(config.colors);
    identomat.setStrings(config.strings);
    identomat.start(config.sessionKey);
```
Tokens:
Raw