
Integration Information Settings Page
API Key
You can view and manage the API key for the project.
API Key Settings
x-api-key header for all API requests.
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.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
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:- Enter name and email address.
- Click the add button to register notification users.
- 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.
Return URL Settings
Return URL Encryption
When the return URL encryption function is activated, return URL parameters are encrypted and delivered.
Return URL Encryption Settings
encrypted parameter.
Encrypted Return URL Example:
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
You can click fields in dynamic fields to set desired fields to be added to the URL. Through dynamic fields, customers can receive the following information in the return URL:| Field | Description |
|---|---|
| kycStatus | KYC result status (approved, pending, rejected) |
| userid | User ID |
| User email address | |
| submissionId | Submission ID |
| cf1, cf2, cf3 | Custom fields 1, 2, 3 |
- Click and select the fields you want to pass in the dynamic fields settings screen.
- Selected fields are automatically added as query parameters to the return URL.
Dynamic Fields UsageUsing dynamic fields, you can include KYC result information in the return URL. This allows customer systems to process KYC results immediately without separate API calls.
Webhook Event Types
The main event types sent via webhook are as follows:| Event | Description |
|---|---|
| approved | Occurs when KYC authentication is approved |
| rejected | Occurs when KYC authentication is rejected |
| pending | Occurs when status changes to require manual review |
| retry | Occurs when retry happens |
| updated | Occurs when submission information is updated |
| delete | Occurs when submission is deleted |
| submit | Occurs when new submission is completed |
| token | When token-related events occur |
| injection | When data injection occurs |
| aml | When AML check results occur |
| aml-ongoing | When AML ongoing monitoring results occur |
Use Cases
Customer Onboarding Process Automation
Customer Onboarding Process Automation
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.
Operations Team Real-time Monitoring and Response
Operations Team Real-time Monitoring and Response
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.
Providing Custom Result Pages
Providing Custom Result Pages
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.
Related Documentation
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.