Skip to main content

What are Webhooks?

Webhooks are a feature that allows you to receive real-time notifications when specific events occur. They automatically send alerts to a designated URL whenever KYC data changes or new information is added.

1. When are webhooks sent?

A webhook is sent to your registered webhook URL whenever one of the events below occurs, such as a submission being created, approved, rejected, updated, or deleted. Receive real-time updates through ARGOS Identity webhooks.
  • “webhook_trigger”: “created” → When the submission is created
  • “webhook_trigger”: “retry” → The submitter proceeded, and the retry occurred
  • “webhook_trigger”: “approved” → The submission is approved as a result of review
  • “webhook_trigger”: “rejected” → The submission is rejected as a result of review
  • “webhook_trigger”: “submit” → The submission becames pending status.
  • “webhook_trigger”: “updated” → The submission is updated (including KYC status changes made through the PATCH/Submission API or the dashboard)
  • “webhook_trigger”: “delete” → The submission delete proceed
  • “webhook_trigger”: “token_expired” → The Token ID has expired
  • “webhook_trigger”: “injection” → The injection proceed in the submission
  • “webhook_trigger”: “aml” → The aml process proceed
  • “webhook_trigger”: “aml_monitor” → The aml_monitor process proceed
Webhook DescriptionWebhook Description Dark

Approved

Rejected

Updated

Delete

Submit

Token expired

Data injection

AML Search Result

AML Ongoing Monitoring Results

By utilizing webhooks, you can monitor all stages of the KYC process in real-time and take immediate action when necessary, enabling more efficient management of your customer onboarding process.

2. Where do I register the webhook URL?

Register the webhook URL in the Webhook URL field under Settings > Access Management in the dashboard. Webhook URL field in dashboard settings
1

Dashboard Login

Log in to the ID check Dashboard.
2

Access Settings Menu

Click on the Settings menu in the top navigation bar of the dashboard.
3

Navigate to Access Management

Select Access Management from the General section in the left sidebar.
4

Enter Webhook URL

Find the Webhook URL section and enter your desired webhook address in the input field. The URL must use the HTTPS protocol and be in a valid format.
5

Save Settings

Click the Save button at the bottom of the page to apply the changes.

3. Activate Encryption Option for Secure Data Transfer

ARGOS Identity provides an encryption option to protect sensitive KYC data transmitted through webhooks. When this feature is activated, all webhook data is automatically encrypted, enabling more secure information exchange.

a. What does encrypted webhook data look like?

Encrypted webhook responses are delivered in the following format:{ "data": "encrypted-string" }, where encrypted-string is the result of encrypting the original data.
data-encrpyted.json
Here, encrypted-string is the result of encrypting the original data.

b. Easily Set Up the Encryption Option

Secure Data Transfer option in dashboard settings
1

Dashboard Login

Log in to the ID check Dashboard.
2

Access Settings Menu

Click on the Settings menu in the top navigation bar of the dashboard.
3

Navigate to Access Management

Select Access Management from the General section in the left sidebar.
4

Enable Secure Data Transfer

Turn on the “Secure Data Transfer” option.
5

Save Settings

Click the Save button at the bottom of the page to apply the changes.
Now that all webhook data is encrypted during transmission, you can exchange important information generated at each stage of the KYC process more securely.

Getting Started

The ID check API is a solution designed to help enterprise clients manage KYC (Know Your Customer) and AML (Anti-Money Laundering) processes more systematically and efficiently. This API supports seamless integration with existing systems and provides features to securely handle and manage user data.

GET/Submission

This API allows you to retrieve ID check submission data. You can fetch detailed information for a specific submission or filter and retrieve a list of multiple submissions.

GET/Submission Response Fields

Detailed definitions of all fields included in GET/Submission API responses

Create and Retry

The webhook will be triggered upon the submission’s initial creation. Additionally, the event will be triggered if it occurs during the retry of the KYC submission process.