1. Opciones Personalizables de Cadena de Consulta
Las opciones de Cadena de Consulta disponibles en Liveform y API le permiten enviar información adicional y personalizar el proceso KYC.2. Estructura Básica de la URL
- URL Base del Formulario:
https://form.argosidentity.com?pid={project_Id} - URL con Cadena de Consulta:
https://form.argosidentity.com?pid={project_Id}&blacklistCountries=false
Puede utilizar la Herramienta de Cifrado/Descifrado de Cadena de Consulta en el panel para generar URLs cifradas y probar los parámetros de cadena de consulta descritos a continuación.
3. Parámetros Clave de Cadena de Consulta
Mostrar Tabla de Parámetros de Cadena de Consulta para ID check y Knowledge-Based
Mostrar Tabla de Parámetros de Cadena de Consulta para ID check y Knowledge-Based
| Parámetro | ID Document | Knowledge-Based | Descripción |
|---|---|---|---|
blacklistCountries | Sí | Sí | Desactiva las restricciones de países en la lista negra para el envío específico (false solo). |
approvePeriod | Sí | No | Desactiva el período de prevención de envíos duplicados aprobados (false solo). |
rejectPeriod | Sí | No | Desactiva el período de prevención de envíos duplicados rechazados (false solo). |
ageLimit | Sí | Sí | Desactiva la restricción de edad para el envío específico (false solo). |
rejectDuplicateUser | Sí | Sí | Habilita/deshabilita la prevención de envíos duplicados (verdadero o false aceptado). - En el Envío basado en Conocimientos, funciona para contener la información de Nombre, Género, Fecha de Nacimiento y Nacionalidad. |
email | Sí | Sí | Dirección de correo electrónico del usuario. |
userid | Sí | Sí | Identificador único personalizado para el usuario. |
pid | Sí | Sí | Identificador único para cada proyecto. |
sid | Sí | Sí | Identificador único para cada envío. |
cf1 | Sí | Sí | Campo de opción personalizada #1. |
cf2 | Sí | Sí | Campo de opción personalizada #2. |
cf3 | Sí | Sí | Campo de opción personalizada #3. |
auxidField | Sí | No | Debe cifrarse. Se utiliza cuando se requiere verificación auxiliar de información de identidad además de documentos de identidad y fotos de selfie. Actualmente se implementa phoneNumber, vea los detalles a continuación. No puede utilizarse simultáneamente con selectedIssuingCountry y selectedIdType. Esto cambiará mediante actualizaciones futuras. |
allowedCountries | Sí | Sí | Debe cifrarse. allowedCountries solo puede establecerse utilizando la opción de cifrado y no puede especificarse directamente. Por ejemplo, si se proporciona el valor cifrado {'allowedCountries': 'USA,KOR'}, solo se permitirán Estados Unidos (USA) y Corea del Sur (KOR). |
allowedIdTypes | Sí | No | Debe cifrarse. Puede establecerse para mostrar el tipo de tarjeta de identidad. Consulte el valor debajo de cada parámetro. |
allowedDocumentFields | Sí | No | Debe cifrarse. Puede establecerse para mostrar los campos disponibles. Consulte el valor debajo de cada parámetro. |
projectionId | Sí | Sí | Debe cifrarse. Puede aplicar una proyección para excluir campos. ProjectionName no puede utilizarse junto con esto. |
projectionName | Sí | Sí | Debe cifrarse. Puede aplicar una proyección para excluir campos. ProjectionId no puede utilizarse junto con esto. |
selectedIssuingCountry | Sí | Sí | Debe cifrarse. Al seleccionarlo, el usuario puede omitir la página de selección de país. allowedCountries y selectedIdType pueden utilizarse juntos. Además, cuando allowedCountries se selecciona, los países que no están en allowedCountries no pueden utilizarse. Los mismos países en blacklistCountries no pueden utilizarse juntos. |
selectedIdType | Sí | No | Debe cifrarse. Al seleccionarlo, el usuario puede omitir la página de selección de tipo de identificación. Debe utilizarse con selectedIssuingCountry. Si selectedIdType se utiliza solo, causará un error. Además, utilizar el modo Universal y selectedIdType juntos causará un error; caso excepcional: tenga en cuenta que si el issuingCountry es KOR y el modo Universal está activado, se mostrará la página de selección de tipo de identificación a los usuarios. |
mainColor | Sí | Sí | Debe cifrarse. Establece el color principal de los botones de CTA y los elementos de la interfaz de usuario de acción positiva. El valor debe ser un código de color hexadecimal de 6 dígitos con el prefijo # (por ejemplo, #AEFF00). Consulte Tema Personalizado y Personalización de Liveform. |
innerColor | Sí | Sí | Debe cifrarse. Establece el color del texto/icono interno dentro de los botones de CTA y los elementos de acción. El valor debe ser un código de color hexadecimal de 6 dígitos con el prefijo # (por ejemplo, #FFFFFF). Consulte Tema Personalizado y Personalización de Liveform. |
Mostrar Tabla de Parámetros de Cadena de Consulta solo para Knowledge-Based
Mostrar Tabla de Parámetros de Cadena de Consulta solo para Knowledge-Based
| Parámetro | ID Document | Knowledge-Based | Descripción |
|---|---|---|---|
knowledgeField | No | Sí | Debe cifrarse. Establecer campos visibles de los campos admitidos. Consulte el valor debajo de cada parámetro. |
knowledgePrefill | No | Sí | Debe cifrarse. Rellenar el valor con antelación. Consulte el valor debajo de cada parámetro. |
skip | No | Sí | Debe cifrarse. Cuando se selecciona, los usuarios pueden omitir el proceso de recopilación de información de usuario en Knowledge-Based y proceder al siguiente paso donde toman una foto de selfie según lo configurado en el panel. No puede utilizarse con otras opciones de knowledgeField. |
3 - Común
Mostrar Omisión de la escritura de Correo Electrónico en los Procesos
Mostrar Omisión de la escritura de Correo Electrónico en los Procesos
- A continuación se muestra un ejemplo de ID Check con y sin un parámetro de consulta de correo electrónico.
- Ejemplo:
https://form.argosidentity.com?pid={project_Id}&email={type_your_email_address}
Mostrar ID de Usuario Único y Campos Personalizados en ID check
Mostrar ID de Usuario Único y Campos Personalizados en ID check
- Genere un ID de usuario único para la identificación del remitente de KYC durante las llamadas a la API.
- Agregue hasta tres campos personalizados (
cf1,cf2,cf3) para transmitir información adicional. - Ejemplo:
https://form.argosidentity.com?pid={project_Id}&userid={type_userid}&cf1={type_cf1}&cf2={type_cf2}&cf3={type_cf3}
Tenga en cuenta que esto es aplicable tanto en ID Document como en Knowledge-Based
3 - ID check
Mostrar Valores de Parámetros en ID check
Mostrar Valores de Parámetros en ID check
[ID document] Valores de Parámetros allowedIdTypes
[ID document] Valores de Parámetros allowedIdTypes
passportdrivers_licensegovernment_idresidence_permitvehicle_registration_certificatevisapancardaadhaarforeign_registratoridentification_card- e.g.
{'allowedIdTypes': 'passport,government_id,drivers_license'}
[ID document] Valores de Parámetros allowedDocumentFields
[ID document] Valores de Parámetros allowedDocumentFields
gendernationalityexpiry_datenumberMismo campo que el número de pasaporteissue_dateid_numberserial_numbernamedate_of_birthcurp_numberSolo disponible para la tarjeta de identidad mexicanaversionSolo disponible para la licencia de conducir de Nueva Zelandatype_of_permitSolo disponible para la Tarjeta de Registro de Extranjeros en Corea del Sur- e.g.
{'allowedDocumentFields': 'gender,name,date_of_birth,issue_date'}
[ID document] Valores de Parámetros selectedIdType
[ID document] Valores de Parámetros selectedIdType
passportdrivers_licensegovernment_idresidence_permitvehicle_registration_certificatevisapancardaadhaaridentification_card- e.g.
{'selectedIdType': 'passport'}
[ID document] Ejemplos
[ID document] Ejemplos
- allowedIdTypes:
https://form.argosidentity.com?pid={project_Id}&encrypted={'allowedIdTypes': 'passport,government_id,drivers_license'}
- allowedDocumentFields:
https://form.argosidentity.com?pid={project_Id}&encrypted={'allowedDocumentFields': 'gender,name,date_of_birth,issue_date'}
- selectedIdType:
https://form.argosidentity.com?pid={project_Id}&encrypted={'selectedIdType': 'passport'}
- nota que dentro de cifrado debería estar cifrado; la consulta anterior es solo como ejemplo
- Cada nombre de campo distingue mayúsculas y minúsculas.
- Cada valor de parámetro no debe contener un espacio.
- ❌ Ejemplo No Cumpliente:
{'allowedDocumentFields': 'gender, name,date_of_birth, issue_date'} - La opción correcta no debe tener espacios después de las comas, como
{'allowedDocumentFields': 'gender,name,date_of_birth,issue_date'}
Mostrar Campo de Identidad Auxiliar en ID check
Mostrar Campo de Identidad Auxiliar en ID check
Para información de identidad que requiere verificación además de documentos de identidad e información de selfie (por ejemplo, números de teléfono), puede recopilar y verificar utilizando la opción auxidField.
Ejemplo:
[ID document] Valores de Parámetros auxidField
[ID document] Valores de Parámetros auxidField
phoneNumberVerificación de número de teléfono basada en SMS e.g.{'auxidField': 'phoneNumber'}
https://form.argosidentity.com?pid={project_Id}&encrypted={'auxidField': 'phoneNumber'}- nota que dentro de cifrado debería estar cifrado; la consulta anterior es solo como ejemplo
Precaución:
- Debe cifrarse para su uso.
- Los valores de parámetro anteriores distinguen mayúsculas y minúsculas. Por ejemplo, si escribe phonenumber, no funcionará. Debe escribir phoneNumber como se muestra arriba.
- No puede utilizarse simultáneamente con selectedIssuingCountry y selectedIdType. Esto cambiará mediante actualizaciones futuras.
- Actualmente 91 países no admiten la verificación por SMS.
Verificar Países No CompatiblesPara ver la lista completa de los 91 países donde la función de verificación por SMS del campo auxidField phoneNumber no es compatible, consulte el enlace siguiente.📋 Lista de Países No Compatibles con la Verificación por SMS
3 - Knowledge-Based
Mostrar Valores de Parámetros en Knowledge-Based
Mostrar Valores de Parámetros en Knowledge-Based
[Knowledge-Based] Valores de Parámetros knowledgeField
[Knowledge-Based] Valores de Parámetros knowledgeField
-
name -
gender -
birthDate -
nationality -
SSN(Solo EE. UU. admitido) -
address -
phoneNumber -
skip: skip debe utilizarse solo y no puede utilizarse con otras opciones de knowledgeField.
e.g.{'knowledgeField': 'gender,nationality,name'}
e.g.{'knowledgeField': 'skip'}
Los valores de parámetro anteriores distinguen mayúsculas y minúsculas. Por ejemplo, birthdate no funcionará. Debe escribir birthDate como se muestra arriba.
[Knowledge-Based] Valores de Parámetros knowledgePrefill
[Knowledge-Based] Valores de Parámetros knowledgePrefill
-
nameIntroducir nombre para prellenar -
birthDateRequerir entrada en formato YYYY-MM-DD -
gendermasculino o femenino -
nationalityCódigo de país ISO Alpha-3 -
SSNNúmero de Seguro Social con guión(-) -
addressIntroducir la palabra clave para buscar en Google Maps -
phoneNumberCódigo de país con número de teléfono sin guión(-) e.g.{'knowledgePrefill': 'gender=male,birthdate=1990-01-01,SSN=123-12-0001,address=Washington D.C.,phoneNumber=+15555551234'}Paraaddress, utilice palabras clave que puedan buscarse en Google Maps. El valor prellenado aparecerá en el campo de búsqueda de dirección.
[Knowledge-Based] Ejemplos
[Knowledge-Based] Ejemplos
https://form.argosidentity.comknowledge?pid={project_Id}&encrypted={'knowledgeField': 'gender,nationality,name'}https://form.argosidentity.comknowledge?pid={project_Id}&encrypted={'knowledgePrefill': 'gender=male,birthdate=1990-01-01,SSN=123-12-0001,address=Washington D.C.,phoneNumber=+15555551234'}- nota que dentro de cifrado debería estar cifrado; la consulta anterior es solo como ejemplo
- Cada nombre de campo distingue mayúsculas y minúsculas.
- Cada valor de parámetro no debe contener un espacio.
- ❌ Ejemplo No Cumpliente:
{'knowledgeField': 'gender, nationality, name'} - La opción correcta no debe tener espacios después de las comas, como:
{'knowledgeField': 'gender,nationality,name'}
Mostrar Solo Selfie en Knowledge-Based
Mostrar Solo Selfie en Knowledge-Based
En
Cuando está configurado, las pantallas de selección de país y entrada de información de usuario se omitirán.
e.g.Ejemplo:
Knowledge-Based, cuando ingresa skip, los usuarios pueden omitir el proceso de recopilación de información de usuario y proceder al siguiente paso. Cuando está configurado, las pantallas de selección de país y entrada de información de usuario se omitirán.
e.g.
{'knowledgeField': 'skip'}CASO DE USO: cuando desea realizar autenticación basada en selfie sin recopilar información adicional, puede implementarlo habilitando la opción de proceso de selfie en el panel y estableciendo ‘skip’ en ‘knowledgeField’.
Precaución:
- No puede utilizarse con otras opciones de knowledgeField además de skip.
- Sin embargo, puede utilizarse junto con el correo electrónico proporcionado por el administrador, userid, cf1, cf2, y cf3.
- Debe cifrarse para su uso.
https://form.argosidentity.comknowledge?pid={project_Id}&encrypted={'knowledgeField': 'skip'}https://form.argosidentity.comknowledge?pid={project_Id}&encrypted={'email': 'example@example.com','userid': 'userid', 'cf1': 'cf1','knowledgeField': 'skip'}- nota que dentro de cifrado debería estar cifrado; la consulta anterior es solo como ejemplo
Mostrar Omisión para Seleccionar País en Knowledge-Based
Mostrar Omisión para Seleccionar País en Knowledge-Based
En Knowledge-Based, si
e.g.
Ejemplo:
allowedCountries establece una nacionalidad.e.g.
{'allowedCountries': 'USA'} El formulario omite la página de selección de país. Ejemplo:
https://form.argosidentity.comknowledge?pid={project_Id}&encrypted={'allowedCountries': 'USA'}- nota que dentro de cifrado debería estar cifrado; la consulta anterior es solo como ejemplo
Todos los valores de Cadena de Consulta deben estar codificados en URL.
4. Opciones de ID de Token
EltokenId es una cadena utilizada para los envíos de Liveform en modo privado.
Propósito: Evitar el uso compartido o duplicado de la misma URL.
Mostrar 4-1. Validación de Token ID
Mostrar 4-1. Validación de Token ID
La validación falla (ocurre un error) bajo las siguientes condiciones:
- Vencimiento por Tiempo: Han transcurrido más de 3 minutos desde el primer uso.
- Envío Válido Existente: Existe un envío con un estado de KYC determinado (aprobado, rechazado, pendiente).
Precaución:
- Si las condiciones anteriores no se cumplen, varios usuarios pueden proceder con el mismo ID de token simultáneamente.
Mostrar 4-2. Métodos para Verificar el ID de Token
Mostrar 4-2. Métodos para Verificar el ID de Token
- Webhook
- API de Obtención de Envío (recuperación única utilizando
submission_id) - Descargar CSV de Envío desde el panel
Mostrar 4-3. Estructura de URL para ID de Token
Mostrar 4-3. Estructura de URL para ID de Token
- URL Base del Formulario:
https://form.argosidentity.com?pid={project_Id} - URL con ID de Token:
https://form.argosidentity.com?pid={project_Id}&token={tokenId} - con Cifrado habilitado:
https://form.argosidentity.com?pid={project_Id}&encrypted={token={tokenId}}
5. Solo Cifrado
Puede habilitar la opción solo cifrado en el panel. Después de la activación, los parámetros de consulta de URL solo permitenpid(id del proyecto), encrypted y lang(idioma), otros parámetros no están permitidos.
-
https://form.argosidentity.com?pid={project_Id}&encrypted={encrypted_option}&lang=en(O) -
https://form.argosidentity.com?pid={project_Id}&encrypted={encrypted_option}&email=your_email_address@argosidentity.com(X) email no es un parámetro permitido, por lo que se deniega el acceso.