### Create Session using Python

Source: https://docs.complycube.com/documentation/api-reference/other-resources/hosted-solution/create-a-session

This Python example shows how to create a session with ComplyCube. Ensure you have the complycube library installed and replace placeholders with your credentials.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

flow_request = {   
        'clientId': 'CLIENT_ID', 
        'workflowTemplateId': 'WORKFLOW_TEMPLATE_ID',
        'successUrl':'https://wwww.yoursite.com/success',
        'cancelUrl':'https://wwww.yoursite.com/cancel'
        }
   
session = ccapi.flow.create(**flow_request)
```

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

### Dynamic Documentation Query Example

Source: https://docs.complycube.com/documentation/api-reference/core-resources/notes/update-a-note

This example shows how to query the documentation dynamically by appending an 'ask' parameter to the URL. Replace `<question>` with your specific query.

```http
GET https://docs.complycube.com/documentation/api-reference/core-resources/notes/update-a-note.md?ask=<question>
```

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

### Install PHP Client Library

Source: https://docs.complycube.com/documentation/api-reference/integration

Install the ComplyCube PHP client library using Composer.

```bash
# Install using composer
composer require complycube/complycube-php
```

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

### Install .NET Client Library

Source: https://docs.complycube.com/documentation/api-reference/integration

Install the ComplyCube client library for .NET using the package manager or .NET CLI.

```powershell
# Install using package manager
Install-Package Complycube

# Install using .NET CLI
dotnet add package Complycube
```

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

### Create a Simple Document Check (PHP)

Source: https://docs.complycube.com/documentation/api-reference/check-types/document-check

This PHP example shows how to create a document check. Ensure the ComplyCube SDK is installed and replace the API key and relevant IDs.

```php
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$result = $ccapi->checks()->create(
    'CLIENT_ID',
    [
        'type' => 'document_check',
        'documentId' => 'DOCUMENT_ID'
    ]
);
```

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

### Install Node.js Client Library

Source: https://docs.complycube.com/documentation/api-reference/integration

Install the ComplyCube API client library for Node.js using npm or Yarn.

```bash
# Install using npm
npm install --save @complycube/api

# Install using Yarn
yarn add @complycube/api
```

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

### Initialize SDK Flow with Token using Java

Source: https://docs.complycube.com/documentation/sdks/mobile-integrations/android-sdk/check-driven-integration

Initiate a ComplyCube verification flow in Java using the SDK builder. This example starts the flow with a client authentication token and client ID.

```java
ComplyCubeSdk.Builder complycubeFlow =
    new ComplyCubeSdk.Builder(this, result - > {});

complycubeFlow.withStages(
    document,
    new SelfiePhoto()
);

complycubeFlow.start(new ClientAuth(
    "SDK_TOKEN",
    "CLIENT_ID"
));
```

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

### List Documents using Python

Source: https://docs.complycube.com/documentation/api-reference/core-resources/documents/list-documents

This Python example shows how to retrieve a list of documents for a client via the ComplyCube API. Make sure to install the complycube library and substitute 'CLIENT_ID' and '<YOUR_API_KEY>' with your credentials.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

documents = cc_api.documents.list('CLIENT_ID')
```

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

### Retrieve Screening Lists (.NET)

Source: https://docs.complycube.com/documentation/api-reference/static-data/screening-lists

This .NET example shows how to get screening lists using the ComplyCube client and StaticApi. Pass your API key to the client constructor and then call ListScreeningListsAsync.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Static;

var screeningListsApi = new StaticApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var result = await screeningListsApi.ListScreeningListsAsync();
```

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

### Install React Native SDK

Source: https://docs.complycube.com/documentation/sdks/mobile-integrations/react-native-sdk/workflow-integration

Install the React Native library using npm.

```bash
npm i -s @complycube/react-native
```

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

### Install Python Client Library

Source: https://docs.complycube.com/documentation/api-reference/integration

Install the ComplyCube client library for Python using pip.

```bash
# Install using pip
pip install complycube
```

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

### Dynamic Documentation Query Example

Source: https://docs.complycube.com/documentation/access-management/single-sign-on-sso/sso-with-okta

To retrieve additional information or clarification not explicitly present on the page, you can perform an HTTP GET request to the documentation URL with an 'ask' query parameter. This allows for dynamic querying of the documentation content.

```http
GET https://docs.complycube.com/documentation/access-management/single-sign-on-sso/sso-with-okta.md?ask=<question>
```

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

### Get all notes for one type

Source: https://docs.complycube.com/documentation/api-reference/core-resources/notes/filtering-notes

This example shows how to retrieve all notes of a specific type, such as 'report', using an HTTP GET request.

```APIDOC
## GET /v1/notes

### Description
Retrieves a list of notes, filterable by type.

### Method
GET

### Endpoint
https://api.complycube.com/v1/notes

### Query Parameters
- **clientId** (string) - Required - The client ID for the request.
- **type** (string) - Required - The type of notes to filter by. Valid values are `internal` and `report`.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/notes?clientId={:clientId}&type=report \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
(Response structure not detailed in the source text)

#### Response Example
(Response example not detailed in the source text)
```

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

### Create a Client (.NET)

Source: https://docs.complycube.com/documentation/quick-guides/web-sdk-quick-guide

This C# example shows how to create a client using the ComplyCube .NET SDK. Ensure you replace <YOUR_API_KEY>.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var newClient = new ClientRequest {
  type = "person",
  email = "john@doe.com",
  personDetails = new PersonDetails {
    firstName = "John",
    lastName = "Doe"
  }
};

var client = await clientApi.CreateAsync(newClient);
```

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

### Get all clients for one type

Source: https://docs.complycube.com/documentation/api-reference/core-resources/clients/filtering

This example demonstrates how to retrieve all clients of a specific type, such as 'company'.

```APIDOC
## GET /v1/clients

### Description
Retrieves a list of clients, with the ability to filter them by various attributes.

### Method
GET

### Endpoint
/v1/clients

### Query Parameters
- **type** (string) - Required - Specifies the type of client to filter by. Valid values are `person` and `company`.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/clients?type=company \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **clients** (array) - A list of client objects matching the filter criteria.

#### Response Example
```json
{
  "clients": [
    {
      "id": "cl_123",
      "type": "company",
      "email": "info@example.com",
      "joinedDate": "2023-01-15T10:00:00Z",
      "externalId": "comp_abc",
      "companyDetails": {
        "name": "Example Corp",
        "website": "https://example.com",
        "registrationNumber": "12345678",
        "incorporationType": "private",
        "incorporationCountry": "US"
      }
    }
  ]
}
```
```

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

### Create Client with .NET

Source: https://docs.complycube.com/documentation/api-reference/core-resources/clients/create-a-client

This C# example demonstrates how to create a client using the ComplyCube .NET SDK. It shows the instantiation of the ClientApi and the structure of the ClientRequest object.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var newClient = new ClientRequest {
  type = "person",
  email = "john.doe@example.com",
  mobile = "+12 345678910",
  telephone = "+12 345678910",
  joinedDate = "2020-01-01",
  personDetails = new PersonDetails {
    firstName = "John",
    lastName = "Doe",
    dob = "1990-01-01",
    nationality = "GB"
  }
}

var client = await clientApi.CreateAsync(newClient);
```

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

### List All Clients (Python)

Source: https://docs.complycube.com/documentation/api-reference/core-resources/clients/list-clients

This Python example demonstrates how to retrieve a list of clients. Instantiate the client with your API key before making the request.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

client_list = cc_api.clients.list()
```

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

### Authenticated Request Example

Source: https://docs.complycube.com/documentation/api-reference/authentication

This snippet demonstrates how to make an authenticated GET request to the /v1/clients endpoint using an API key. It shows the cURL command and equivalent examples in Node.js, Python, PHP, and C#.

```APIDOC
## GET /v1/clients

### Description
Retrieves a list of clients. This is an example of an authenticated request.

### Method
GET

### Endpoint
https://api.complycube.com/v1/clients

### Parameters
#### Headers
- **Authorization** (string) - Required - Your API key in the format "<YOUR_API_KEY>"

### Request Example
```http
GET https://api.complycube.com/v1/clients \
     -H "Authorization: <YOUR_API_KEY>"
```

### Response
#### Success Response (200)
(Response structure not detailed in source)

#### Response Example
(Response example not detailed in source)
```

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

### .NET: Get Document

Source: https://docs.complycube.com/documentation/api-reference/core-resources/documents/get-a-document

This C# example shows how to get a document using the ComplyCube.Net library. Instantiate the ComplyCubeClient with your API key and use the DocumentApi's GetAsync method, providing the document ID.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;

var docApi = new DocumentApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var document = await docApi.GetAsync("DOCUMENT_ID");
```

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

### Get workflow sessions by outcome

Source: https://docs.complycube.com/documentation/api-reference/core-resources/workflow-sessions/filtering-workflow-sessions

This example demonstrates how to retrieve all workflow sessions that have a specific outcome, such as 'clear'.

```APIDOC
## GET /v1/workflowSessions

### Description
Retrieves a list of workflow sessions, with the ability to filter them based on various criteria.

### Method
GET

### Endpoint
/v1/workflowSessions

### Query Parameters
- **outcome** (string) - Optional - Filters workflow sessions by their outcome. Valid values are `clear`, `attention`, and `rejected`.
- **status** (string) - Optional - Filters workflow sessions by their status. Valid values are `started`, `processing`, `complete`, `abandoned`, and `cancelled`.
- **workflowTemplateId** (string) - Optional - Filters workflow sessions by their workflow template ID.
- **workflowId** (string) - Optional - Filters workflow sessions by their workflow ID.
- **workflowVersion** (string) - Optional - Filters workflow sessions by their workflow version.
- **clientId** (string) - Optional - Filters workflow sessions by their client ID.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/workflowSessions?outcome=clear \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **workflowSessions** (array) - A list of workflow session objects matching the filter criteria.

#### Response Example
```json
{
  "workflowSessions": [
    {
      "id": "wf_session_id_1",
      "outcome": "clear",
      "status": "complete",
      "workflowTemplateId": "wf_template_id_1",
      "workflowId": "wf_id_1",
      "workflowVersion": "1.0",
      "clientId": "client_id_1",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

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

### Create a Person Client (.NET)

Source: https://docs.complycube.com/documentation/quick-guides/api-quick-guide/run-an-aml-screening-check

This .NET example shows how to create a 'person' client using the ComplyCube.Net library. Initialize the ClientApi with your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var newclient = new ClientRequest {
  type = "person",
    email = "john.doe@example.com",
    personDetails = new PersonDetails {
      firstName = "John",
        lastName = "Doe",
        dob = "1990-01-01"
    }
};

var client = await clientApi.CreateAsync(newclient);
```

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

### Retrieve Workflow Session using Python

Source: https://docs.complycube.com/documentation/api-reference/core-resources/workflow-sessions/get-a-workflow-session

This Python example shows how to get a workflow session using the ComplyCube client library. Provide your API key and the workflow session ID to the client and the get method.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

workflow_session = cc_api.workflowsessions.get('WORKFLOW_SESSION_ID')
```

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

### Create a Client using Node.js SDK

Source: https://docs.complycube.com/documentation/sdks/mobile-integrations/react-native-sdk/workflow-integration

This Node.js example demonstrates creating a client with the ComplyCube SDK. Replace '<YOUR_API_KEY>' with your API key.

```javascript
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.client.create({
  type: "person",
  email: "john.doe@example.com",
  personDetails: {
    firstName: "John",
    lastName": "Doe"
  }
});
```

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

### Get all enabled webhooks

Source: https://docs.complycube.com/documentation/api-reference/other-resources/webhooks/filtering-webhooks

This example demonstrates how to retrieve all webhooks that are currently enabled and are configured for completed clear events.

```APIDOC
## GET /v1/webhooks

### Description
Retrieves a list of webhooks, with options to filter by enabled status and specific events.

### Method
GET

### Endpoint
/v1/webhooks

### Query Parameters
- **enabled** (string) - Optional - Filters webhooks based on their enabled status (e.g., `true` or `false`).
- **events** (string) - Optional - Filters webhooks by the events they are subscribed to (e.g., `check.completed.clear`).

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/webhooks?enabled=true&events=check.completed.clear \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **webhooks** (array) - A list of webhook objects matching the filter criteria.

#### Response Example
```json
{
  "webhooks": [
    {
      "id": "wh_abc123",
      "url": "https://example.com/webhook",
      "enabled": true,
      "events": ["check.completed.clear"],
      "created_at": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### Get all team members for a specific role

Source: https://docs.complycube.com/documentation/api-reference/other-resources/team-members/filtering-team-members

This example demonstrates how to retrieve all team members who have a specific role, such as 'analyst'.

```APIDOC
## GET /v1/teamMembers

### Description
Retrieves a list of team members, with the ability to filter by role.

### Method
GET

### Endpoint
/v1/teamMembers

### Query Parameters
- **role** (string) - Optional - The role to filter team members by.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/teamMembers?role=analyst \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **teamMembers** (array) - A list of team member objects matching the filter criteria.

#### Response Example
```json
{
  "teamMembers": [
    {
      "id": "tm_123",
      "firstName": "John",
      "lastName": "Doe",
      "role": "analyst",
      "email": "john.doe@example.com"
    }
  ]
}
```
```

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

### Example Web SDK Stages Configuration

Source: https://docs.complycube.com/documentation/sdks/web-integrations/web-sdk-quick-guide/web-sdk-quick-guide-1

This JavaScript snippet demonstrates how to configure the stages for a Web SDK verification flow, including options for intro, document capture, face capture, proof of address, and completion.

```javascript
stages: [
  {
    name: "intro",
    options: {
      heading: "We need to verify your identity",
      message: [
        "In order to open an account, we need to check a few things.",
        "This will take only a moment",
      ],
      startButtonText: "Start Verification"
    },
  },
  "userConsentCapture",
  {
    name: "documentCapture",
    options: {
      crossDeviceOnly: true,
      documentTypes: {
        passport: true,
        driving_license: false,
        national_identity_card: true,
        residence_permit: {
          country: "GB",
        },
      },
    },
  },
  {
    name: "faceCapture",
    options: {
      mode: "video"
    },
  },
  {
    name: "poaCapture",
    options: {
      documentTypes: {
        bank_statement: true,
        utility_bill: false,
      },
    },
  },
  {
    name: "completion",
    options: {
      heading: "Thank you for completing the process",
      message: ["we will get in touch shortly"]
    },
  }
];
```

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

### Mount and Update SDK Settings

Source: https://docs.complycube.com/documentation/sdks/web-integrations/web-sdk-quick-guide/web-sdk-quick-guide

Mounts the SDK and demonstrates how to update settings like the token and modal visibility at runtime.

```javascript
complycube = ComplyCube.mount({...});

// Replace the SDK token
complycube.updateSettings({ token: "NEW_SDK_TOKEN" });
...
// Open the modal
complycube.updateSettings({ isModalOpen: true });

//Close the modal
complycube.updateSettings({ isModalOpen: false });

```

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

### Get all documents for one type

Source: https://docs.complycube.com/documentation/api-reference/core-resources/documents/filtering-documents

This example demonstrates how to retrieve all documents of a specific type, such as 'passport', using a cURL request.

```APIDOC
## GET /v1/documents

### Description
Retrieves a list of documents, with the ability to filter them by various attributes.

### Method
GET

### Endpoint
/v1/documents

### Query Parameters
- **clientId** (string) - Required - The client ID for which to retrieve documents.
- **type** (string) - Optional - Filters documents by their type. For example, 'passport'.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/documents?clientId={:clientId}&type=passport \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **documents** (array) - A list of document objects matching the filter criteria.

#### Response Example
(Response structure not explicitly detailed in the source, but would contain a list of documents)

### Attributes for Filtering
- **type** (string) - Filters documents by type. Refer to the Document object for supported values.
- **classification** (string) - Filters documents by classification. Refer to the Document object for supported values.
- **issuingCountry** (string) - Filters documents by the issuing country using a two-letter ISO code.
```

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

### List Live Videos using .NET

Source: https://docs.complycube.com/documentation/api-reference/core-resources/live-videos/list-live-videos

This .NET example shows how to list live videos for a client using the ComplyCube .NET SDK. Instantiate the `ComplyCubeClient` with your API key and use the `ListAsync` method of the `liveVideoApi`.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.LiveVideos;

var videoApi = new liveVideoApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var videos = liveVideoApi.ListAsync("CLIENT_ID").Result;
```

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

### Get all checks for one type

Source: https://docs.complycube.com/documentation/api-reference/core-resources/checks/filtering-checks

This example demonstrates how to retrieve all checks of a specific type, such as 'document_check', using the ComplyCube API.

```APIDOC
## GET /v1/checks

### Description
Retrieves a list of checks, with the ability to filter them by various attributes.

### Method
GET

### Endpoint
https://api.complycube.com/v1/checks

### Query Parameters
- **type** (string) - Optional - Specifies the type of checks to retrieve. For example, `document_check`.
- **clientId** (string) - Optional - Filters checks by a specific client ID.
- **status** (string) - Optional - Filters checks by their status. Valid values are `pending`, `complete`, and `failed`.
- **documentId** (string) - Optional - Filters checks by a specific document ID.
- **addressId** (string) - Optional - Filters checks by a specific address ID.
- **livePhotoId** (string) - Optional - Filters checks by a specific live photo ID.
- **liveVideoId** (string) - Optional - Filters checks by a specific live video ID.
- **enableMonitoring** (string) - Optional - Filters checks based on monitoring status. Valid values are `true` and `false`.
- **result.outcome** (string) - Optional - Filters checks by the outcome of the result. Valid values are `clear`, `attention`, `not_processed`, and `rejected`.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/checks?type=document_check \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **checks** (array) - A list of check objects matching the filter criteria.

#### Response Example
```json
{
  "checks": [
    {
      "id": "chk_abc123",
      "type": "document_check",
      "status": "complete",
      "createdAt": "2023-10-27T10:00:00Z",
      "result": {
        "outcome": "clear"
      }
    }
  ]
}
```
```

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

### Dynamic Documentation Query Example

Source: https://docs.complycube.com/documentation/api-reference/core-resources/checks/filtering-checks

This example demonstrates how to query the documentation dynamically by appending an 'ask' parameter with your question to the documentation URL. This is useful for retrieving information not explicitly present on the page.

```bash
GET https://docs.complycube.com/documentation/api-reference/core-resources/checks/filtering-checks.md?ask=<question>
```

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

### Get all addresses for one type

Source: https://docs.complycube.com/documentation/api-reference/core-resources/addresses/filtering-addresses

This example demonstrates how to retrieve all addresses of a specific type, such as 'main', using a cURL request or various SDKs.

```APIDOC
## GET /v1/addresses

### Description
Retrieves a list of addresses, with the ability to filter them by various attributes.

### Method
GET

### Endpoint
/v1/addresses

### Query Parameters
- **clientId** (string) - Required - The ID of the client.
- **type** (string) - Optional - Filters addresses by type. Valid values are `main`, `alternative`, and `other`.

### Request Example
```bash
curl -X GET https://api.complycube.com/v1/addresses?clientId={:clientId}&type=main \
     -H 'Authorization: <YOUR_API_KEY>'
```

### Response
#### Success Response (200)
- **addresses** (array) - A list of address objects matching the filter criteria.

#### Response Example
```json
{
  "addresses": [
    {
      "type": "main",
      "propertyNumber": "10",
      "buildingName": "",
      "line": "10 Downing Street",
      "city": "London",
      "state": "",
      "country": "GB"
    }
  ]
}
```
```

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

### Get Workflow Sessions by Outcome in .NET

Source: https://docs.complycube.com/documentation/api-reference/core-resources/workflow-sessions/filtering-workflow-sessions

This .NET example illustrates filtering workflow sessions by outcome. It utilizes the WorkflowSessionApi and requires your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.WorkflowSessions;

var wfSessionsApi = new WorkflowSessionApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var filter = new WorkflowSessionRequest { outcome = "clear" }

var wfSessions = await wfSessionsApi.ListAsync(filter);
```

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

### List Live Photos (.NET)

Source: https://docs.complycube.com/documentation/api-reference/core-resources/live-photos/list-live-photos

This .NET example shows how to list live photos using the ComplyCube SDK. Initialize the `LivePhotoApi` with a `ComplyCubeClient` instance and call `ListAsync` with the client ID.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.LivePhotos;

var livePhotoApi = new LivePhotoApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var livePhotos = await livePhotoApi.ListAsync("CLIENT_ID");
```

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

### Resource Not Found Response (404) for Get Note

Source: https://docs.complycube.com/documentation/api-reference/core-resources/notes/get-an-address

This is an example of a response when the requested note ID is not found. It indicates an invalid note ID was provided.

```json
{
    "type": "resource_not_found",
    "message": "Invalid note id '5eb1276f96be4a0008713af5'"
}
```

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

### Get Team Members by Role (.NET)

Source: https://docs.complycube.com/documentation/api-reference/other-resources/team-members/filtering-team-members

This .NET example shows how to filter team members by role using the ComplyCube client. Provide your API key in place of '<YOUR_API_KEY>'.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.TeamMembers;

var teamMemberApi = new TeamMemberApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var teamMemberRequest = new TeamMemberRequest { role = "administrator" };

var teamMembers = await teamMemberApi.ListAsync(teamMemberRequest);
```

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

### List All Clients (.NET)

Source: https://docs.complycube.com/documentation/api-reference/core-resources/clients/list-clients

This .NET example shows how to asynchronously list clients. The ClientApi requires a ComplyCubeClient instance initialized with your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;

var clientApi = new ClientApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var clients = await clientApi.ListAsync();
```

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

### Create Client with Python

Source: https://docs.complycube.com/documentation/api-reference/core-resources/clients/create-a-client

This Python snippet shows how to create a client using the ComplyCube library. It initializes the client with your API key and then calls the create method with the necessary client data.

```python
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

new_client = {
    'mobile':"+12 345678910",
    'telephone': "+12 345678910",
    'joinedDate': "2020-01-01",
    'personDetails': {
        'firstName':'John',
        'lastName': "Doe",
        'dob': "1990-01-01",
        'nationality': "GB"
    }
}

client = cc_api.clients.create('person','john.doe@example.com', **new_client)
```

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

### Python: Get Document

Source: https://docs.complycube.com/documentation/api-reference/core-resources/documents/get-a-document

This Python example shows how to retrieve a document using the ComplyCubeClient. Instantiate the client with your API key and use the documents.get method, passing the document ID.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

document = cc_api.documents.get('DOCUMENT_ID')
```

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

### Download Live Photo using .NET

Source: https://docs.complycube.com/documentation/api-reference/core-resources/live-photos/download-live-photo

This C# example demonstrates downloading a live photo with the ComplyCube .NET SDK. Initialize the LivePhotoApi with your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.LivePhotos;

var livePhotoApi = new LivePhotoApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var livePhoto = await livePhotoApi.DownloadAsync("LIVE_PHOTO_ID");
```

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

### Create a Client using Python

Source: https://docs.complycube.com/documentation/quick-guides/hosted-solution-quick-guide

This Python snippet shows how to create a client with the ComplyCube API. Remember to substitute '<YOUR_API_KEY>' with your valid API key.

```python
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

new_client = {
    'type':'person',
    'email':'john.doe@example.com',
    'personDetails': {
        'firstName':'John',
        'lastName':'Doe'
    }
}

client = cc_api.clients.create(**new_client)
```

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

### Node.js Request to Get Supported Documents

Source: https://docs.complycube.com/documentation/api-reference/static-data/screening-lists-1

This Node.js snippet demonstrates how to use the ComplyCube API to list supported documents. Ensure you have the `@complycube/api` package installed and replace `<YOUR_API_KEY>` with your credentials.

```javascript
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const screeningLists = await complycube.static.listSupportedDocuments();
```

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

### Create Client with Node.js

Source: https://docs.complycube.com/documentation/api-reference/core-resources/clients/create-a-client

Integrate client creation into your Node.js application using the ComplyCube SDK. This example demonstrates how to instantiate the client and call the create method with person details.

```javascript
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.client.create({
  type: "person",
  email: "john.doe@example.com",
  mobile: "+12 345678910",
  telephone: "+12 345678910",
  joinedDate: "2020-01-01",
  personDetails: {
    firstName: "John",
    lastName: "Doe",
    dob: "1990-01-01",
    nationality: "GB"
  }
});
```

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

### Retrieve Webhook using PHP

Source: https://docs.complycube.com/documentation/api-reference/other-resources/webhooks/get-a-webhook

This PHP example illustrates fetching a webhook via the ComplyCube API. Instantiate the client with your API key and call the `get` method with the webhook ID.

```php
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$webhook = $ccapi->webhooks()->get('WEBHOOK_ID');
```

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

### Retrieve Webhook using Node.js

Source: https://docs.complycube.com/documentation/api-reference/other-resources/webhooks/get-a-webhook

This Node.js snippet demonstrates how to get a webhook using the ComplyCube API client. Ensure you have the `@complycube/api` package installed and replace `WEBHOOK_ID` and `<YOUR_API_KEY>` with your specific values.

```javascript
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

await complycube.webhook.get("WEBHOOK_ID")
```

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

### Mount the Web SDK

Source: https://docs.complycube.com/documentation/sdks/web-integrations/web-sdk-quick-guide/web-sdk-quick-guide-1

Initialize the Web SDK in your frontend with a generated SDK token. Configure stages, and define callbacks for completion, modal closure, and errors.

```javascript
ComplyCube.mount({
  token: '<YOUR_WEB_SDK_TOKEN>',
  containerId: 'complycube-mount',
  stages: [
    'intro',
    'documentCapture',
    {
      name: 'faceCapture',
      options: {
        mode: 'video'
      }
    },
    'completion'
  ],
  onComplete: function(data) {
    // Using the data attributes returned, request your
    // backend server to perform the necessary ComplyCube checks
    console.info('Capture complete');
  },
  onModalClose: function() {
    // Handle the modal closure attempt
  },
  onError: function ({ type, message }) {
    if (type === 'token_expired') {
      // Request a new SDK token
    } else {
      // Handle other errors
      console.error(message);
    }
  }
});
```

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

### List Documents using .NET

Source: https://docs.complycube.com/documentation/api-reference/core-resources/documents/list-documents

This C# example demonstrates how to list documents for a client using the ComplyCube .NET SDK. You need to initialize the DocumentApi with your API key and client ID.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;

var docApi = new DocumentApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var documents = await docApi.ListAsync("CLIENT_ID");
```

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

### Success Response (200) for Get Custom List

Source: https://docs.complycube.com/documentation/api-reference/tools/custom-lists/get-a-custom-list

This is an example of a successful response when retrieving a custom list. It includes details such as the list's ID, name, description, statistics, and creation/update timestamps.

```json
{
    "id": "5fd52391d8506552e4f3c8c4",
    "name": "Retail Banking Fraud (UK)",
    "description": "Entities involved in mortgage fraud.",
    "stats": {
        "personCount": 4101,
        "companyCount": 258
    },
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:24:29.146Z"
}
```

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

### Query Documentation

Source: https://docs.complycube.com/documentation/sdks/web-integrations/web-sdk-quick-guide/web-sdk-quick-guide

Shows how to query the documentation dynamically by making an HTTP GET request with an 'ask' query parameter.

```http
GET https://docs.complycube.com/documentation/sdks/web-integrations/web-sdk-quick-guide/web-sdk-quick-guide.md?ask=<question>

```

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

### List Live Videos using Python

Source: https://docs.complycube.com/documentation/api-reference/core-resources/live-videos/list-live-videos

This Python example shows how to retrieve a list of live videos for a client using the ComplyCube Python client. Instantiate the client with your API key and use the `list` method.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

livevideos = cc_api.livevideos.list('CLIENT_ID')
```

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

### List Workflow Sessions (.NET)

Source: https://docs.complycube.com/documentation/api-reference/core-resources/workflow-sessions/list-workflow-sessions

This .NET example demonstrates listing workflow sessions using the ComplyCube client. Initialize the API with your provided API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.WorkflowSessions;

var wfSessionsApi = new WorkflowSessionApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var workflowSessions = await wfSessionsApi.ListAsync();
```

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

### Generate Check Report using Python

Source: https://docs.complycube.com/documentation/api-reference/other-resources/reports/generate-check-report

This Python example demonstrates generating a check report with the ComplyCube API. Install the complycube library and substitute '<YOUR_API_KEY>' and 'CHECK_ID' with your actual API key and the check ID.

```python
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

check = cc_api.reports.generate_check_report('CHECK_ID')
```

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

### List Team Members using .NET

Source: https://docs.complycube.com/documentation/api-reference/other-resources/team-members/list-team-members

This .NET example shows how to set up the ComplyCube client and retrieve team members asynchronously. Replace '<YOUR_API_KEY>' with your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.TeamMembers;

var teamMemberApi = new TeamMemberApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var teamMembers = await teamMemberApi.ListAsync();
```

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

### Get documents by type using .NET

Source: https://docs.complycube.com/documentation/api-reference/core-resources/documents/filtering-documents

This .NET example shows how to filter documents by type. Create a DocumentApi instance with your ComplyCube client, define a DocumentRequest object with the desired type, and then call the ListAsync method.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;

var docApi = new DocumentApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var filter = new DocumentRequest { type = "passport" };

var filtered = await docApi.ListAsync("CLIENT_ID", filter);
```

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

### Get Checks by Type (.NET)

Source: https://docs.complycube.com/documentation/api-reference/core-resources/checks/filtering-checks

This C# example shows how to retrieve checks of a specific type using the ComplyCube .NET SDK. It involves creating a CheckApi instance and passing a CheckRequest object with the desired type.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Checks;

var checkApi = new CheckApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var filter = new CheckRequest { type = "document_check" }

var docChecks = await checkApi.ListAsync(filter);
```

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

### Create Session using .NET

Source: https://docs.complycube.com/documentation/api-reference/other-resources/hosted-solution/create-a-session

This C# example demonstrates how to create a session using the ComplyCube .NET SDK. It requires initializing the FlowSessionApi with your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.FlowSessions;

var fSession = new FlowSessionApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var flowSession = new FlowSessionRequest {
  clientId = "CLIENT_ID",
  workflowTemplateId = "WORKFLOW_TEMPLATE_ID",
  successUrl = "https://www.yoursite.com/success",
  cancelUrl = "https://www.yoursite.com/cancel"
};

var result = fSession.CreateAsync(flowSession).Result;
```

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

### Initialize ComplyCube iOS SDK

Source: https://docs.complycube.com/documentation/sdks/mobile-integrations/ios-sdk/check-driven-integration

Initialize the SDK with your token, client ID, and desired stages. This sets up the flow for the client.

```swift
let sdk = ComplyCubeMobileSDK.FlowBuilder()
  .withSDKToken("SDK_TOKEN")
  .withClientId("CLIENT_ID")
  .withStages([documentStage, selfieStage])
  .start(fromVc: self)

var clientAuth = ClientAuth("SDK_TOKEN", "CLIENT_ID")
```

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

### Get Company Details using Node.js

Source: https://docs.complycube.com/documentation/api-reference/tools/company-search/get-company-details

This Node.js snippet demonstrates how to fetch company details using the ComplyCube API client. Ensure you have the @complycube/api package installed and replace <YOUR_API_KEY> and COMPANY_ID with your credentials and the target company's ID.

```javascript
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.lookup.getCompany("COMPANY_ID");
```

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

### List Webhooks using .NET

Source: https://docs.complycube.com/documentation/api-reference/other-resources/webhooks/list-webhooks

This C# example demonstrates how to list webhooks with the ComplyCube .NET client. Initialize the client and webhook API with your API key.

```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Webhooks;

var webhookApi = new WebhookApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var webhooks = await webhookApi.ListAsync();
```

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

### Mounting the SDK with Basic Settings

Source: https://docs.complycube.com/documentation/sdks/web-integrations/web-sdk-quick-guide/web-sdk-quick-guide-1

This snippet shows how to mount the ComplyCube SDK with essential settings like token and container ID. Ensure the container element exists and is empty.

```javascript
complycube = ComplyCube.mount({
  token: "YOUR_SDK_TOKEN",
  containerId: "complycube-mount"
});
```

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

### Install ComplyCube iOS SDK with CocoaPods

Source: https://docs.complycube.com/documentation/sdks/mobile-integrations/ios-sdk/workflow-integration

Install the ComplyCube SDK using CocoaPods by adding the 'ComplyCubeMobileSDK' to your Podfile and configuring build settings. Ensure you have the CocoaPods plugin installed.

```bash
sudo gem install cocoapods
```

```ruby
source 'https://github.com/CocoaPods/Specs.git'
…
platform :iOS, ’13.0’

target ‘YourApp’ do
    …
  pod 'ComplyCubeMobileSDK'
end

post_install do |installer|
    installer.pods_project.targets.each do |target|
        target.build_configurations.each do |build_configuration|
            build_configuration.build_settings['ENABLE_BITCODE'] = 'NO'
            build_configuration.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
            build_configuration.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.1'
            build_configuration.build_settings['ARCHS'] = ['$(ARCHS_STANDARD)', 'x86_64']
            build_configuration.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = ['arm64', 'arm64e', 'armv7', 'armv7s']
            build_configuration.build_settings['GENERATE_INFOPLIST_FILE'] = 'YES'
        end
    end
end
```