# Application

* You can create new and manage existing applications through the `Applications` section in Workplace:

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FoUzJVrbYzzPKySJOvTuw%2FScreenshot%202025-02-19%20at%2018.53.46.png?alt=media&#x26;token=290a59fe-a1ec-48f6-9391-ab62e04615a8" alt=""><figcaption></figcaption></figure>

* As soon as your application is created you can open it anytime and get the details required for further integration.

### Application Configuration Overview

Each application contains essential parameters for API authentication, webhook integration, and user redirection:

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2F7P5meH0o4X5moIMXMzoh%2FScreenshot%202025-04-16%20at%2011.56.16.png?alt=media&#x26;token=d7d1e821-1d01-4599-b618-287b413830be" alt=""><figcaption></figcaption></figure>

#### **Application Name (Required)**

* **Purpose:** The unique name used to identify your application.
* **Usage:** This field is **mandatory** and must be filled in when creating an application. Choose a name that clearly represents your application’s purpose.

#### **Description (Optional)**

* **Purpose:** Provides additional context about the application.
* **Usage:** This field is optional but can be used to store notes or details about the application's purpose, functionality, or integration details.

#### **Redirect URL**

* **Purpose:** Specifies the URL where users will be redirected after completing the applicant flow.
* **Usage:** This should point to a page in your application where users continue their process after verification.

**How to Set the Redirect URL**

1. In the **Application Details** section, locate the **Redirect URL** field.
2. Enter the **URL** where applicants should be redirected after verification (e.g., `https://www.yourapp.com/success`).
3. Click `Save changes` to confirm.

#### Encryption Method

* **Purpose:** Specifies the encryption algorithm used to protect sensitive data associated with a particular application.
* **Usage:** Choose between **AES-256-CBC** and **AES-256-GCM** based on your security and performance needs. This setting helps ensure compliance with security standards and allows you to align encryption preferences with internal policies or partner requirements.\
  \- **AES-256-CBC** – A widely adopted and secure encryption standard, suitable for most use cases.\
  \- **AES-256-GCM** – Offers improved performance and built-in authentication, recommended when additional integrity protection is needed.

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FEb1es115NB1IF7BOEZfl%2FScreenshot%202025-04-16%20at%2011.56.16%20copy.png?alt=media&#x26;token=ecc3a409-8ef9-4fca-9ddd-544c36d3f86d" alt=""><figcaption></figcaption></figure>

### Application ID, Crypto Key, and Private App Key

After the application is **created and saved**, the system generates the following **unique keys**:

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2Fn1NJbmbTgcjbKb7BrT3W%2FScreenshot%202025-02-19%20at%2018.57.51.png?alt=media&#x26;token=1458e9f8-112a-4c7c-99ab-49803ce645e6" alt=""><figcaption></figcaption></figure>

#### **Application ID**

* **Purpose:** A unique identifier for your application.
* **Usage:** This ID is used internally within the system to reference your application during API interactions.

#### **Crypto Key**

* **Purpose:** Used for encrypting and decrypting data exchanged between your application and our services.
* **Usage:** Retrieve this key to securely transmit sensitive data.

{% hint style="info" %}
You can regenerate the Crypto Key if needed, but this will invalidate the previous key.
{% endhint %}

#### **Private App Key**

* **Purpose:** Required for authentication when interacting with the **Public API**.
* **Usage:** Include this key in API requests to ensure secure and authorized access.

{% hint style="info" %}
These keys are generated only after the application is created and saved.

For security reasons, store these keys securely, as they provide access to API functionalities.
{% endhint %}

### Webhook Integration

The **Webhook** tab allows you to set up notifications and event tracking for your application.

#### **Webhook Endpoint**

* **Purpose:** Defines a Webhook URL where our system will send real-time event notifications about applicant status and other updates.
* **Usage:** Provide a URL that can handle requests from our system. These notifications help automate workflows and keep your application up-to-date.

#### **Response Headers**

* **Purpose:** Add custom response headers to ensure secure and authenticated communication between your application and the webhook receiver.
* **Usage:** Multiple headers can be added to support security and other necessary configurations.

**How to Configure Webhooks**

1. Navigate to the **Webhook** tab in the **Application Settings**.
2. Click `Add notifications via webhook` to create a new webhook connection.

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FgMYDiHhv1Xo3o8z9SXFI%2FScreenshot%202025-02-19%20at%2018.59.19.png?alt=media&#x26;token=6c558761-9adf-4650-aa32-70d38ac81a0e" alt=""><figcaption></figcaption></figure>

3. Enter a **Webhook Name** and **Webhook URL**

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FE1efcoCsYIaHTUIoCmWc%2FScreenshot%202025-02-19%20at%2018.59.35.png?alt=media&#x26;token=90ea5df1-e3bb-4f6b-8719-d84e5ce5e88b" alt=""><figcaption></figcaption></figure>

4. To add custom headers:

* Click `Add response headers`
* Enter a **Key** and **Value** pair (e.g., `Authorization: Bearer <token>`).
* Repeat this step to add multiple response headers if needed.

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FR170c7cx6scxpI7A4uP1%2FScreenshot%202025-02-19%20at%2019.02.11.png?alt=media&#x26;token=cfccfcb0-3dff-4bbf-ab49-2884099ba7c5" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2Fogih8bJ8ucZGolnmvhdz%2FScreenshot%202025-02-19%20at%2019.02.20.png?alt=media&#x26;token=82d03e6c-d722-424c-a40c-fd81488e0667" alt=""><figcaption></figcaption></figure>

5. Click `Save changes` to apply the configuration.

### Failed Webhook Deliveries

The **Failed Webhook Deliveries** section provides insights into webhook events that failed due to issues on the client side. This feature helps users identify errors and troubleshoot their webhook configurations.

#### **How to View Failed Webhook Deliveries**

1. Navigate to the **Webhook** tab in the **Application Settings**.
2. Scroll down to the **Failed Webhook Deliveries** section.

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FGFYldybYjJ2KpagWFnrV%2FScreenshot%202025-02-19%20at%2019.08.14.png?alt=media&#x26;token=4859a55e-6636-47cb-af20-5d169b0519df" alt=""><figcaption></figcaption></figure>

3. Click `View Failed Webhooks` to open the failure log.
4. The failure log displays:
   * **EVENT\_ID** – A unique identifier for each failed event.
   * **EVENT\_TYPE** – The type of webhook event (e.g., `APPLICANT_COMPLETED`, `APPLICANT_DUPLICATE_DOCUMENT`).
   * **ERROR\_MESSAGE** – A description of why the webhook request failed (e.g., "Expired document").

<figure><img src="https://1111746725-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3YdYFOUPi8bWAiBfJgPb%2Fuploads%2FAnD5497prC79zuuMMOma%2FScreenshot%202025-02-19%20at%2019.08.21.png?alt=media&#x26;token=697d0e1d-075d-42c5-b78b-cb556ac5bf83" alt="" width="375"><figcaption></figcaption></figure>

***
