Saltar al contenido principal

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.

​
2026-04-29

​
Adición de nombre completo en inglés (full_name_en)

ID_Check v2.3.0Se agregó el campo full_name_en (BD: fullNameEn) a la respuesta de Submission cuando se aprueba KYC. El nombre se convierte mediante transliteración y no se traduce libremente (ej: 김 산 → KIM SAN). First/Last name no se convierten, y no están incluidos en la lógica de comparación de liveform.

​
Liveform Streaming — Opción de Image Quality Check para imágenes cargadas

LiveForm v2.2.0Se agregó un selector de Image Quality Check a las imágenes cargadas cuando Liveform Streaming está activado + opción de carga de documento de identidad activada. El valor por defecto es ON para ejecutar IQC en FE, y puede cambiar a OFF para omitir IQC en imágenes cargadas.

​
startValidUntil — Configuración de período de validez antes del inicio de autenticación

ID_Check v2.3.0LiveForm v2.2.0Se agregó la opción de parámetro de cadena de consulta startValidUntil, que permite establecer un período de validez antes de que el usuario inicie la autenticación. Se evalúa antes de la validación de token. Cuando se accede en estado expirado, se redirige al nuevo código de error PV-40018.
​
2026-04-24

​
Adición de la pestaña Device Info y Fingerprint option

ID_Check v2.2.0LiveForm v2.1.0La configuración de Refuerzo de autenticación y prevención de falsificación se ha expandido a 3 pestañas. La opción Device Verification se ha movido a la nueva pestaña Device Info, y se han añadido Fingerprint option basada en Fingerprint del dispositivo (detección de máquina virtual / emulador / bot malicioso / manipulación de navegador) y Device Duplicate Check. La verificación de Device Info se realiza primero al ingresar al liveform.

​
División del pipeline de Verificación de Datos Gubernamentales por tipo de ID

ID_Check v2.2.0LiveForm v2.1.0Government Data Verification - Corea ha pasado del anterior toggle único ON/OFF a interruptores individuales por tipo de ID (Resident ID / Driver License / Passport / Alien Registration). Puede configurar la verificación de autenticidad para documentos de identidad específicos según la política del cliente, y también puede desactivar selectivamente solo el documento afectado en caso de problemas temporales en el servidor.

​
Soporte para envío de código de error en Return URL

ID_Check v2.2.0LiveForm v2.1.0Se ha añadido el nuevo campo Error Code (errorCode) a los Campos Dinámicos de Información de integración > Return URL del Dashboard. Incluso cuando el usuario accede a una página de error, puede regresar al servicio del cliente mediante el botón de Return URL, y el parámetro errorCode permite identificar inmediatamente el motivo del bloqueo.

​
Estandarización de códigos de error de token (TK-10000 ~ TK-10004)

LiveForm v2.1.0Se han asignado 5 códigos de error con prefijo TK- a las páginas de error relacionadas con tokens, y los mensajes para el usuario han sido mejorados. El código y la definición se muestran juntos en la página de error, facilitando la resolución de problemas.

​
Prevención de Incomplete Submission durante picos de tráfico

LiveForm v2.1.0Se ha mejorado el problema de Incomplete Submission que ocurría durante la escala automática. Se verifica la carga de tráfico de forma anticipada al iniciar eKYC y antes del envío del documento de identidad en el Paso 1, y en caso de detectar sobrecarga, se muestra una pantalla de espera y se realiza un reintento automático.
​
2026-04-07

​
Opciones de acción para Expired ID

Se ha añadido una nueva opción Expired ID en Prevención de fraude y falsificación, que permite elegir cómo gestionar los documentos expirados: Retry o Warning (por defecto: Retry). Al seleccionar Warning se omiten las condiciones de Expired ID del Paso 1 y del Paso 2 y la verificación se aprueba en estado Warning; además, se ha añadido una condición de Warning al listado de Trigger de Custom Policy.

​
ID Liveness: Warning automático en modo Upload

Cada pipeline de ID Liveness (Screen Replay / Paper Print / Portrait Replacement) con Retry seleccionado ahora expone una nueva casilla secundaria Apply Warning on Upload. Al marcarla, el Retry del pipeline se convierte a Warning solo cuando el usuario envía el documento en modo Upload, y la verificación aparece en Custom Policy con userDataType: ID_card_uploaded / relatedEngine: ID Liveness Screen replay.

​
Cambio de contraseña de la cuenta desde el dashboard

Ahora puede cambiar la contraseña directamente desde el menú de cuenta del dashboard sin cerrar sesión. Si OTP no está configurado, el cambio ocurre directamente en el modal; si OTP está configurado, se cambia tras la verificación de OTP.

​
Búsqueda de Submission: longitud mínima reducida (3 → 2)

La longitud mínima de búsqueda en el listado de Submission se ha reducido de 3 a 2 caracteres, permitiendo buscar con normalidad en entornos que usan userId de 2 caracteres.

​
Passive Face Auto Capture

Se ha añadido Auto Capture a la captura pasiva de rostro del liveform. El mensaje de guía se ha movido a la parte superior de la pantalla, se añade un nuevo tipo de captura face-passive-auto-capture y el tiempo de espera se reduce de 2 s → 1 s.

​
OCR de fecha de expiración para la Tarjeta de Registro de Extranjero de Corea

Se habilita el reconocimiento de la fecha de expiración (expiry_date) en la Tarjeta de Registro de Extranjero de Corea. El OCR consulta expiry_date → expiry_date0 por orden de prioridad y el resultado se devuelve en la API GET Submission en data.idcard_expireDate.
​
2026-03-30

​
Mongolian & Turkish language support

Mongolian (mn) and Turkish (tr) have been added as supported languages for the KYC liveform.

​
Passive liveness capture UI improvement

The passive liveness capture screen now displays a guide message after 2 seconds to help users complete the capture. The guide message UI supports the custom color theme.

​
Image rotation in liveform

Users can now rotate uploaded images 90° clockwise before submission in the liveform, allowing correction of misoriented documents.
​
2026-03-25

​
Custom Theme added

You can now apply your brand colors to the KYC liveform using the mainColor and innerColor query string parameters. CTA buttons and positive action UI elements will reflect your custom colors, helping maintain brand consistency throughout the KYC flow.
  • Must be encrypted for use
  • Value format: 6-digit hex with # prefix (e.g., #AEFF00)
  • Applies to CTA buttons and positive action indicators only
  • Negative indicators and black text are not affected (planned for future update)
  • Custom Theme product update
  • Liveform Customization dashboard guide
  • Query String and Token Guide developer guide
​
2026-03-20

​
Device Verification added

Device Verification has been added to analyze device information accessing KYC authentication and preemptively block non-mobile device access such as desktops, virtual environments, and bots.

​
Pre-verification List menu separated

The pre-verification list, previously under User Submissions, has been separated into an independent menu with VPN & Proxy and Device Verification pages.

​
Custom policy reject code added

The reject code applied_custom_policy has been added for rejections due to custom policy application.
​
2026-03-19

​
Administrator invitation feature added

The administrator invitation feature has been added to project administrator settings. You can add administrators by entering their email and name. Unregistered users receive an invitation email. Invitation history and status can be checked from the dashboard.
  • Already registered users are added as administrators immediately
  • Unregistered users receive an invitation email (valid for 7 days)
  • View invitation status and cancel invitations from the invitation history
  • System operation dashboard guide
​
2026-03-16

​
Custom policy rules added

Custom policy rules have been added to the KYC process. Using a visual flow editor, you can connect triggers (conditions) and actions (results) to build project-specific KYC policies.
  • Triggers: User field modification, OCR confidence threshold, warning detection
  • Actions: ARGOS Score cap, penalty (score deduction), KYC status override
  • Up to 5 policies per project
  • Active/inactive toggle for policy control
  • KYC process dashboard guide

​
PUT Image API documentation improved

The PUT Image API documentation has been improved with multipart/form-data request guidance and Python code examples.
​
2026-02-15

​
QueryString encryption/decryption simulation tool

A simulation tool for encrypting and decrypting QueryStrings has been added. Developers can easily test and verify encryption logic.

​
Error page refinement

Previously unified error pages have been split by error type. Each error now displays a specific message and screen for improved user experience.

​
OCR confidence score display

OCR confidence scores are now displayed in the dashboard, making it easier for operators to assess recognition accuracy.

​
Dashboard token tooltip added

Tooltips have been added to token-related features in the dashboard, helping users understand token usage and configuration.

​
Liveform search improvements

Search conditions and result sorting in Liveform have been improved for better operational efficiency.

​
Supported ID type management

A new feature allows flexible management of supported ID types per project from the dashboard.
​
2026-01-21

​
Recognition failure information improvement

When recognition failure occurs, users now see the definition of their selected ID type and a list of submittable ID types, reducing confusion during retries.

​
QueryString ID type selection display improvement

When an ID type is specified via QueryString in Liveform, the selected ID type is now visible on screen and locked from user modification.
​
2026-01-14

​
Submission list retryCount column added

A retry count (retryCount) column has been added to the dashboard submission list, allowing you to check retry status for each submission at a glance.

​
Dashboard timezone-based data display

Submission data in the dashboard is now displayed based on the user’s configured timezone setting.

​
QR code page design improvement

The QR code page UI/UX has been improved for a cleaner, more intuitive experience.
​
2025-12-30

​
Anti-forgery warning feature added

A warning feature has been introduced for the ID anti-forgery option. Instead of immediate rejection when below the threshold, a warning is recorded and the process can continue. Warning records are saved in the submission and a Warning section has been added to the dashboard submission detail.

​
ISMS security requirements applied

ISMS security standards have been applied to the dashboard administrator system.
  • Administrator system access logs retained for 5 years
  • Account lockout on login failure with improved notification
  • Session timeout (3 hours) applied

​
Dashboard credit usage statistics improvement

Daily credit usage now displays up to three decimal places. A UI tooltip explaining credit usage calculation and notation has been added.

​
MRZ name comparison options refined by ID type

MRZ name comparison criteria for passports and other ID types can now be configured separately in the dashboard, allowing different similarity thresholds per ID type.

​
Active liveness guide page added

When the Active Liveness option is enabled, a user guide page is displayed before capture. Guidance on screen brightness and environment improves authentication success rates.

​
Dashboard ID liveness naming standardization

ID Liveness-related labels and warning messages have been standardized for consistency across the dashboard.
​
2025-12-24

​
ID Liveness guide added

A detailed guide for the ID Liveness verification feature has been added.
​
2025-12-19

​
Stay expiry date lookup added

The expiryDateOfStayKor field has been added to GET Submission API. You can now look up the stay expiry date registered with the Korean Ministry of Justice.
​
2025-12-03

​
Projection API added

The Projection feature has been added to exclude specific fields from webhook and GET Submission responses. This helps reduce network costs and PII storage burden.
A maximum of 10 projection policies can be saved per project.
​
2025-11-24

​
Private Token Auto-Deletion Based on Registration Volume

Added automatic deletion functionality when pre-registered token volume reaches a threshold. This enables smooth token volume management.
​
2025-11-19

​
Camera Process Information Added

The cameraProcessInfo field has been added to GET Submission API and GET FaceAuth API. This allows you to check detailed information about the camera capture process.
​
2025-11-13

​
Webhook Token Feature Added

Added webhook token functionality to enhance webhook security. This allows you to verify the integrity of webhook requests.

​
PATCH/Submission and Search Face API Improvements

PATCH/Submission API has been updated so that the data field is no longer required.
​
2025-11-11

​
GET Submission API Update

The updateHistory field has been added to GET Submission API, allowing you to track the update history of submissions. Submission information retrieval functionality has been improved overall.
​
2025-11-06

​
GET Projects API Added

Added GET Projects API to retrieve project lists.
​
2025-11-04

​
Name Fields Added

The firstName and lastName fields have been added to webhook events (approved, updated) and PATCH/Submission, POST/Submission APIs.
​
2025-10-29

​
GET Submission API Extension

Support for the typeOfPermit field has been added to GET Submission API. This allows you to retrieve permit type information.
​
2025-10-17

​
Complete Onboarding Guide Added

Added a complete onboarding guide for developers. It provides step-by-step guidance from initial setup to advanced features.
​
2025-10-12

​
FaceAuth Add-on Feature Added and Improved

FaceAuth add-on functionality has been added and improved overall. Fixed errors in GET FaceAuth Image API, and changed redirect settings for SEO.
​
2025-09-19

​
GET Submission API Extension

The detectFace field has been added to GET Submission API.
​
2025-09-15

​
GET Submission API Extension

The image object has been added to GET Submission API, allowing you to retrieve image information in more detail.
​
2025-09-11

​
KYC Patch Memo Feature

Memo functionality has been added to KYC Patch API.
​
2025-09-05

​
Token ID Pre-registration Added

You can now pre-register Token IDs to be used via API. If a token is deleted or expires through the “Token Expiration Condition Settings”, access to Live-form will be denied. For more details, refer to the POST Token API and Service Guide.
​
2025-08-29

​
Ongoing Monitoring Webhook Added

Added a webhook to receive AML ongoing monitoring results. Continuous monitoring is now possible for approved submissions.
​
2025-08-27

​
Ongoing Monitoring Feature Added and Knowledge-based Selfie-Only Feature

  1. AML ongoing monitoring functionality has been added. You can continuously monitor approved users against watchlists.
  2. When using the skip parameter in Knowledge-based via QueryString, users can skip the PII input step and complete KYC authentication with selfie only.
​
2025-08-08

​
Encryption Module GCM Registration

GCM (Galois/Counter Mode) algorithm has been registered in the encryption module. Additional options are provided for enhanced security. For more details, check the Encryption and Decryption page and Service Guide.
​
2025-08-06

​
Return URL Enhancement

Enhanced the return URL behavior by appending the submission_id parameter after submission completion. This allows integration partners to reliably track user submissions.

​
Encryption Algorithm Update

AES-GCM was added as a new encryption option alongside existing methods, and a new encryption key was introduced. Admins can now flexibly choose from multiple encryption modules based on their security requirements.
​
2025-08-01

​
Manual Submission Control System

Admins can now immediately block new submissions for a project if an emergency stop is required. When stopped, the project URL changes, and access via POST API is blocked. To resume the project, the status must be manually changed via the dashboard.

​
Retry Flow Improvement

In cases where both front and back images failed, the retry flow used to start from the back image page. It has now been updated so that the retry flow starts from the front image page instead.
​
2025-07-30

​
Submission Rate Limiting

When configured, user access is allowed based on the specified number of submissions or allowed time window. If the configured limits are violated, access to the liveform is denied. Additionally, by setting an access block duration, users who violate the initial access logic are granted a specific time after which they can reattempt to access the liveform.

​
Encrypted Image Transmission

Implemented encryption for image uploads from the front-end when sending images to the liveform. GET Submission api now provides id_LivenessScore.
​
2025-07-28

​
Vertical Mode Support

Added support for vertical mode during ID document capture in Step 1, along with UI improvements for better user experience.

​
Engine Update

Updated ID engine to support 95 new ID documents from 46 countries.

​
Name Field English Conversion

All ID document names are now automatically converted to English and stored in the dashboard, regardless of ID type and country.
​
2025-07-21

​
SMS Verification Feature

Added SMS verification functionality that requires encrypted URL query parameters. Admins can verify phone numbers in submission details after submission.

​
UX Improvements

Active liveness now gets captured by the tip button. Passive liveness gets captured by the tip button while hiding existing “See the Selfie Guide”. Updated duplicate user rejection message from “KYC is rejected” to “Your Identification has previously been verified. Further attempts are not allowed under the policy.”
​
2025-07-14

​
eKYC Process Resume Feature

Users can now resume interrupted eKYC processes between Step 1 and Step 2 after navigating away, refreshing, or restarting the page. The system uses unique hash-based identification with 15-minute validity to track user progress and determine the appropriate resume point.
​
2025-07-11

​
Search Functionality Enhancement

It is now possible to search items by userid, nationality has been added. AML Search Performance improved. The information message for Private Mode has been improved.
​
2025-07-04

​
Review Owner Feature

Added Review Owner functionality in User policy settings.

​
Additional Information Enhancement

Improved Additional Information section in Settings.
​
2025-06-27

​
POST/REVIEW API Added

A new API has been added that allows project administrators to directly review pending KYC submissions. Project settings can configure reviewers as either Client or Argos Agent, and when set to Client, Agents will not review those pending submissions.
​
2025-06-20

​
CURP Validation Display

The dashboard now displays CURP validation information.

​
Liveness Score Display

When ID liveness retry happens, the dashboard shows the liveness score on the retry message. It is visible on the dashboard under the submission details.
​
2025-06-19

​
ID Document KYC Enhancement

Enhanced the KYC process for ID documents to display information tooltips regarding national IDs when selecting the appropriate ID type.

​
State ID Support

The Console now has an option for Identification cards (only for the USA): The administrator can add an ID type called State ID in the Liveform.
​
2025-06-18

​
Partial Delete API

Added Partial Delete API for management purposes. Clients can delete data in part. Refer to the developer guide for more information.
​
2025-06-17

​
CURP Validation Feature

Added CURP Validation functionality in Dashboard > Settings > Multi Verification & Anti Fraud. Validates CURP number from 3rd Party API.

​
AML Watchlist Filtering

Added AML Watchlist filtering in Dashboard > Settings > Anti Money Laundering. AML score thresholds and checkboxes for exact DOB matching can be set by the administrator.
​
2025-06-16

​
Added QueryString parameter[selectedIssuingCountry and selectedIdType]

You can start the KYC process immediately with the selected country and ID type. The URL Query must be encrypted with the encrypted parameter to be set up.
​
2025-05-30

​
Return URL Added

The administrator can configure the return URL with the necessary parameters, and the submitter will be redirected to the return URL with the parameters they have already set from the dashboard when they click the “Ok” button.
​
2025-05-23

​
Webhook Retry added

The webhook will be triggered if a retry occurs during the submission.

​
Update of GET/SUBMISSION

Injection action records are now displayed in GET/SUBMISSION. The maximum number of injection actions in a record is 10, and the address details are not displayed in the record.
​
2025-05-14

​
Address Injection

After submission approval, it can inject address information with validation. The injection process can be restricted if the user has an unusual connection, like a proxy or VPN. Also restrict injection if the user’s IP address is far from the inputted address.
​
2025-05-08

​
Added the custom DI (duplicated information)

The admin can manage duplicate submissions from the dashboard and set a custom DI based on submission information. Both the custom DI set and the existing DI are offered. The custom DI value can be obtained by the developer through the GET/SUBMISSION API.

​
Added allowedIdTypes, allowedDocumentFields

During the KYC process for ID document, can set the permissible ID type and the permissible document fields. It can be set from an encrypted URL query parameter.

​
Projection

When the user submits KYC, a projection can be applied to exclude sensitive information from the GET/SUBMISSION API, such as sensitive fields like name and birthdate. The projection list can be managed through the use of GET/Projection, POST/Projection, and DELETE/Projection. Additionally, the projection can be applied when the user completes the KYC process by using the URL query string.
​
2025-03-27

​
Knowledge-based Added

The existing LiveForm is designated as the ID Document, and a new feature called Knowledge-based has been introduced. The encryption section has been updated, and new query string parameters have been added to facilitate the Knowledge-based functionality.
​
2024-01-23

​
DI Field Added

  • GET/Submission API: The DI(duplicated information) field has been added to identify and manage duplicated data. This field provides a hash value for duplicated information.
  • Webhook Events: The DI(duplicated information) field has been added to all events, returning a hash value for any duplicated information.
​
2024-12-16

​
The Documentation Has Been Revamped 🚀

To enhance your development experience, we have completely overhauled the documentation. Whether you’re a first-time user or an experienced developer, this update ensures you can quickly understand and utilize the resources.

​
What’s New in This Update

​
1. Reorganized Documentation Structure

We’ve restructured the documentation into a more systematic and intuitive format. The table of contents and sections have been neatly arranged for quick access to the information you need.

​
2. Enhanced API References

Every endpoint now comes with detailed explanations and practical example codes. Parameters and response formats are clearly laid out to boost your development efficiency.

​
3. New Tutorial Section

Step-by-step guides are now available for first-time users. Start from the basics and learn how to utilize the documentation effectively.

​
4. Upgraded Search Functionality

Find what you’re looking for faster with improved search algorithms. Features like keyword auto-completion and related document suggestions have been added.

​
We Value Your Feedback

Did you find the documentation helpful? Share your opinion by clicking Yes or No at the bottom of each section. For additional suggestions or feedback, feel free to reach out to our CS team. We look forward to hearing from you!
We are committed to creating a better development environment by continuously improving our services. Thank you for being part of our journey. We will keep listening to your valuable feedback. Sincerely, The ARGOS Identity Team
To view the previous version of the documentation, click here.