Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

Integration information settings support real-time data integration with customer systems. You can build smooth integration with business systems through API key management, webhook settings, return URL configuration, dynamic field settings, etc.
Integration information settings

​
API Key

You can view and manage the API key for the project.
API key settings
API key is a unique key used for authentication when calling ARGOS ID Check API. It must be included in the x-api-key header for all API requests.
API Key SecurityBe careful not to expose API keys externally. If an API key is leaked, all project data can be accessed, so it must be managed securely.
API Key UsageYou can use various API functions such as submission queries, approval/rejection processing, token management, etc. using the API key.

​
Webhook Settings

The Webhook function supports real-time data integration with customer systems. When specific events occur, it sends HTTP POST requests to the endpoint (Endpoint URL) set by the customer, enabling real-time notifications and data processing without separate API calls.
Webhook settings

​
Webhook URL Settings

Set the endpoint URL where the customer system will receive webhook data. HTTP POST requests are sent to the set URL when webhook events occur.
Webhook Security and StabilityWebhook endpoints must use HTTPS to ensure secure data transmission. It is also recommended to implement signature verification mechanisms to verify the authenticity of webhook requests.
Firewall Configuration RequiredThe IP address used by ARGOS when sending webhooks is 52.78.194.237. To receive webhooks normally, you must configure the firewall to allow requests from this IP address.
Firewall Configuration MethodAdd the following IP address to the allow list in your customer’s firewall or security group settings:
  • Webhook IP: 52.78.194.237
If HTTP POST requests from this IP address are not allowed, webhooks will be blocked and cannot be received.
Webhook IP and URL ManagementFixed webhook IPs for each project can only be viewed on this page, and webhook URL change history is not stored, so please be mindful of webhook URL management.

​
Notification User Management

By adding names and emails through notification user management, you can receive information about webhooks sent yesterday via email the next morning. Configuration Method:
  1. Enter name and email address.
  2. Click the add button to register notification users.
  3. Registered users receive webhook information sent the previous day via email every morning.
Daily Webhook ReportA summary of all webhook events sent the previous day (00:00 ~ 23:59 UTC) is sent via email to registered notification users every morning. This allows you to monitor webhook transmission status.

​
Return URL

Users are redirected to the set URL when KYC is completed or when they are taken to an error page.
Return URL settings
When the KYC process is completed and the submitter selects the “Ok” button or waits for 5 seconds, they are redirected to the return URL with the parameters selected in dynamic fields. Starting with the 2026-04 update, the return URL can also be reached after landing on an error page, and in that case the errorCode parameter is included so that your service can identify the reason for the block. Return URL Example (normal completion): 
https://yourapp.com/verification-complete?userid=user123&email=user@example.com&kycStatus=approved&submissionId=sub_abc123&cf1=campaign_summer
Return URL Example (error page → return URL): 
https://yourapp.com/verification-complete?kycStatus=rejected&errorCode=DE-20000

​
Return URL Encryption

When the return URL encryption function is activated, return URL parameters are encrypted and delivered.
Return URL encryption settings
When return URL encryption is activated, parameters selected in dynamic fields are encrypted and included in the encrypted parameter. Encrypted Return URL Example: 
https://yourapp.com/verification-complete?encrypted={encrypted_data}
Return URL Encryption UsageWhen using return URLs containing sensitive information (email, user ID, etc.), you can strengthen security by activating the encryption function. AES-256-ECB method is used for decryption.

Encryption Guide

Learn how to decrypt return URL encryption data.
Return URL UsageAfter KYC completion, users can be automatically redirected to the customer’s service page, providing customized guidance pages according to approval/rejection status.

​
Skip Result Page

You can skip users viewing KYC results and redirect to your desired URL. When the skip result page function is activated, it skips the KYC result page and moves directly to the return URL. Usage Scenarios:
  • When customers want to provide their own result page
  • When you want to flexibly provide results through dynamic field parameters in the return URL
Skip Result Page and Dynamic Fields CombinationWhen you activate the skip result page function and select parameters such as kycStatus, submissionId in dynamic fields, KYC result information is included in the return URL. This allows customers to configure their own result pages.

​
Dynamic Fields

Click the checkboxes in dynamic fields to select which items to pass as return URL query parameters. The selected values are automatically reflected in the Final Return URL preview at the bottom of the screen.
FieldParameter keyDescription
User IDuseridUser ID
EmailemailUser email address
Submission IDsubmissionIdSubmission ID
Custom Field #1·#2·#3cf1, cf2, cf3User-defined fields
KYC StatuskycStatusKYC result status (approved, pending, rejected)
Error Code 2026-04 NewerrorCodeError code passed when the user reaches an error page (e.g., DE-20000, TK-10001)
Final Return URL preview: 
https://argosidentity.com?kycStatus={kycStatus}&errorCode={errorCode}
Using the Error Code (errorCode) parameterWhen you check Error Code in dynamic fields, users who land on an error page can return to your service via the return URL button, with the errorCode value included in the query string. This lets your service identify the reason for the block (e.g., Device Verification failure, token expiry). For the full error code mapping, see the Error Codes and Pages reference.
Dynamic Fields PrecautionsThe kycStatus and errorCode parameters follow camelCase, so case must be accurately distinguished. kycStatus returns one of approved, pending, or rejected depending on the result.

​
Webhook Event Types

The main event types sent via webhook are as follows:
EventDescription
approvedOccurs when KYC authentication is approved
rejectedOccurs when KYC authentication is rejected
pendingOccurs when status changes to require manual review
retryOccurs when retry happens
updatedOccurs when submission information is updated
deleteOccurs when submission is deleted
submitOccurs when new submission is completed
tokenWhen token-related events occur
injectionWhen data injection occurs
amlWhen AML check results occur
aml-ongoingWhen AML ongoing monitoring results occur

​
Use Cases

When a financial institution’s new customer’s KYC authentication is completed, they can receive immediate notifications via webhook and automatically proceed with follow-up processes such as account opening, card issuance, and service activation. Using return URLs and dynamic fields, customized guidance pages can be provided to customers according to approval/rejection status.
When KYC submissions are rejected or specific risk factors are detected, immediate notifications can be sent to the operations team via webhook for rapid response. You can check the previous day’s webhook transmission status every morning through the notification user management function.
Customers can configure their own result pages using the skip result page function and dynamic fields. Since KYC result information is included in the return URL, results can be processed immediately without separate API calls.

Project Information

View project basic information settings.

Webhook Event Overview

View complete overview of webhook events.

Return URL Guide

Learn how to use return URLs in detail.

Approved Webhook

View approved webhook payload.

Rejected Webhook

View rejected webhook payload.

API Reference

Learn how to use APIs.