Todos los productos
Search
Centro de documentos

ID Verification:Native SDK custom UI integration (New)

Última actualización: Sep 06, 2026

El SDK nativo de Identity Verification le permite personalizar los colores y los íconos de la interfaz. Mediante la interfaz setCustomUIConfig, puede pasar una configuración de interfaz como archivo o en formato JSON. Este tema describe los parámetros de la interfaz y proporciona ejemplos de código.

Nota

Algunas configuraciones personalizadas dependen de la versión del SDK. Actualice el SDK a la versión más reciente antes de usarlo.

Si la configuración personalizada de la interfaz entra en conflicto con los parámetros extendidos de la API de verificación, la configuración de la interfaz tiene prioridad.

Directrices de configuración

  • Versión mínima del SDK: 1.4.0 o posterior.

  • Herencia predeterminada: si no pasa un elemento de configuración o sus propiedades de estilo, el sistema utiliza el valor predeterminado.

  • Manejo de elementos de configuración no válidos:

    • Los valores de color deben tener el formato #RRGGBB o #AARRGGBB. Si pasa un valor no válido, el sistema utiliza el valor predeterminado y devuelve un mensaje de error.

    • Un ícono Base64 debe ser una cadena de imagen Base64 con un prefijo válido, como data:image/png;base64,.... Si pasa un valor no válido, el sistema utiliza el valor predeterminado y devuelve un mensaje de error.

  • Configuración incremental: para simplificar el proceso, pase únicamente los elementos que necesita modificar y deje los demás con sus valores predeterminados.

API

Android

Definición de la API

El SDK de Android proporciona la API setCustomUIConfig para personalizar los colores y los íconos de la interfaz. Llame a este método con los parámetros obligatorios para aplicar su configuración personalizada.

    /**
     * Sets custom UI colors and icons.
     *
     * @return A string containing any exception information detected in the configuration file.
     * @description This API is used to set the custom UI.
     * @paramType paramType The parameter type {@link IDTFacade}. Valid values are
     * {@link IDTFacade#EXT_PARAMS_CONFIG_JSON} or {@link IDTFacade#EXT_PARAMS_CONFIG_ASSETS_NAME}.
     *
     * @param param The parameter value, which corresponds to the specified paramType.
     */
    public String setCustomUIConfig(@IDTFacade int paramType, String param) {
     // ...
    }

Parámetros

Parámetro

Tipo

Descripción

paramType

int

Configure el tipo del parámetro de entrada personalizado. Los valores disponibles son los siguientes:• IDTFacade.EXT_PARAMS_CONFIG_ASSETS_NAME: tipo de archivo de recursos de la aplicación. El parámetro param especifica el nombre del archivo de recursos.• IDTFacade.EXT_PARAMS_CONFIG_JSON: cadena JSON. El parámetro param especifica los datos en formato JSON.

param

String

Los datos de configuración. El contenido depende del valor de paramType.

Valor devuelto

Devuelve un objeto String que contiene detalles sobre cualquier error o excepción detectada al analizar sintácticamente el contenido de param. Revise este valor para obtener información específica del error si su configuración no es válida.

Ejemplo

// Method 1: Pass the assets file name
String customUIErrMsg = IdentityPlatform.getInstance()
    .setCustomUIConfig(IDTFacade.EXT_PARAMS_CONFIG_ASSETS_NAME, "DTCustomUIConfig.json");

// Method 2: Pass a JSON string
String customUIErrMsg = IdentityPlatform.getInstance()
    .setCustomUIConfig(IDTFacade.EXT_PARAMS_CONFIG_JSON, jsonConfig);

// We recommend that you print the return value during integration testing.
Log.d("CustomUI", "errMsg: " + customUIErrMsg);

iOS

El SDK de iOS proporciona la API setCustomUI para personalizar los colores y los íconos de la interfaz. Llame a este método con los parámetros obligatorios para aplicar su configuración personalizada.

    /**
     * Sets custom UI colors and icons.
     *
     * @completeBlock A callback that reports the result of the configuration.
     * @configuration The JSON string for the custom UI.
     */
   - (void)setCustomUI:(nonnull NSString *)configuration
           complete:(void(^_Nullable)(BOOL success, NSError * _Nullable error, NSDictionary *warningDict))completeBlock {
    ......
}

Parámetros

Parámetro

Tipo

Descripción

configuration

String

La cadena JSON de la interfaz personalizada.

completeBlock

block

Una función de devolución de llamada que informa el resultado de la configuración:

  • success = YES: la configuración se aplicó correctamente.

  • success = NO: la configuración falló. El objeto error proporciona detalles sobre el fallo.

Valor devuelto

Este método no tiene un valor de retorno directo. Los resultados se devuelven de forma asíncrona mediante la función de devolución de llamada completeBlock. El parámetro warningDict de esta función es un objeto NSDictionary que contiene advertencias de configuración, como el uso de campos obsoletos. Estas advertencias no provocan que la configuración falle, pero se recomienda revisarlas.

Ejemplo

[[AliyunIdentityPlatform sharedInstance] setCustomUI:customUIJSON complete:^(BOOL success, NSError * _Nullable error, NSDictionary *warningDict) {
    if (!success) {
        NSLog(@"Failed to parse custom UI: %@", error.localizedDescription);
    } else if (warningDict.count > 0) {
        NSLog(@"Custom UI warnings: %@", warningDict);
    }
}];

Estructura de la configuración

Esta configuración utiliza seis directorios de nivel superior, cada uno con ajustes detallados de los campos:

{
  "commonConfig": { },
  "dialogConfig": { },
  "guideConfig": { },
  "ocrConfig": { },
  "faceConfig": { },
  "nfcConfig": { }
}

Parámetro

Descripción

commonConfig

Configuración general para todas las páginas, incluido el botón de acción principal, los íconos de retroceso y cierre, y el color del texto de carga.

dialogConfig

Cuadros de diálogo de alerta globales del SDK: colores del título, del texto principal y del texto de los botones.

guideConfig

Página de guía: colores del título principal y del texto del cuerpo.

ocrConfig

Página de reconocimiento OCR y página de resultados.

faceConfig

Página de reconocimiento facial: título, texto de indicación, fondo y barra de progreso.

nfcConfig

Página de lectura NFC, modal de estado de lectura y página de entrada de información.

Configuración predeterminada

A continuación se muestra un JSON con los valores de color predeterminados del SDK y marcadores de posición para los íconos codificados en Base64. Copie este código y modifíquelo según sus necesidades:

{
  "commonConfig": {
    "loadingMessageColor": "#000000",
    "btnBGColor": "#FF6A00",
    "btnDisableBGColor": "#D5D5D5",
    "btnMessageColor": "#F9F9FA",
    "btnDisableMessageColor": "#F9F9FA",
    "exitIconBase64": "data:image/png;base64,..."
  },
  "dialogConfig": {
    "titleColor": "#000000",
    "messageColor": "#888888",
    "primaryActionColor": "#FF6A00",
    "secondaryActionColor": "#000000",
    "singleActionColor": "#FF6A00"
  },
  "guideConfig": {
    "titleColor": "#3D3D3D",
    "contentColor": "#333333"
  },
  "OCRConfig": {
    "borderColor": "#ffffff",
    "titleColor": "#ffffff",
    "albumLabelColor": "#ffffff",
    "takePhotoLabelColor": "#ffffff",
    "submitTitleColor": "#ffffff",
    "floodLightBase64": "data:image/png;base64,...",
    "unFloodLightBase64": "data:image/png;base64,...",
    "autoScanBase64": "data:image/png;base64,...",
    "takeShootBase64": "data:image/png;base64,...",
    "albumBase64": "data:image/png;base64,...",
    "takePhotoBase64": "data:image/png;base64,...",
    "submitBase64": "data:image/png;base64,...",
    "resultTitleColor": "#000000",
    "resultTipColor": "#000000",
    "resultTipBgColor": "#EDEDED",
    "resultErrorTipColor": "#C80000",
    "resultErrorTipBgColor": "#FFE0DC",
    "resultErrorTipIconBase64": "data:image/png;base64,...",
    "resultInfoTitleColor": "#333333",
    "resultInfoContentColor": "#999999",
    "resultInfoContentBgColor": "#F7F7F7",
    "resultInfoBorderColor": "#FF6A00"
  },
  "faceConfig": {
    "titleColor": "#000000",
    "tipColor": "#000000",
    "bgColor": "#ffffff",
    "progressStartColor": "#80ffffff",
    "progressEndColor": "#FF6A00"
  },
  "NFCConfig": {
    "titleColor": "#3D3D3D",
    "contentColor": "#3D3D3D",
    "readStatusTextColor": "#3D3D3D",
    "readStatusExitBase64": "data:image/png;base64,...",
    "inputTitleColor": "#262626",
    "inputLabelColor": "#333333",
    "inputEditColor": "#333333",
    "inputEditHintColor": "#999999"
  }
}

Ejemplo de configuración mínima

Este ejemplo modifica únicamente los colores del botón principal y del título. Todas las demás opciones de configuración utilizan los valores predeterminados del SDK:

{
  "commonConfig": {
    "btnBGColor": "#FF6A00",
    "btnMessageColor": "#FFFFFF"
  },
  "ocrConfig": {
    "titleColor": "#FFFFFF"
  },
  "faceConfig": {
    "titleColor": "#000000"
  }
}

Referencia de campos y valores predeterminados

commonConfig

Parámetro

Descripción

Color predeterminado

Vista previa en Android

Vista previa en iOS

loadingMessageColor

El color del mensaje de carga se especifica con loadingMessageColor. El color predeterminado varía según la página, pero se estandariza a un solo color después de configurar este parámetro.

#000000/ #ffffff

image

image

btnBGColor

Color de fondo del botón de acción principal (estado habilitado).

#FF6A00

image

image

btnDisableBGColor

Color de fondo del botón de acción principal (estado deshabilitado).

#D5D5D5

image

image

btnMessageColor

Color del texto del botón de acción principal (estado habilitado).

#F9F9FA

image

image

btnDisableMessageColor

Color del texto del botón de acción principal (estado deshabilitado).

#F9F9FA

image

image

exitIconBase64

Ícono del botón de retroceso o cierre de la página.

data:image/png;base64,...

image

image

dialogConfig

Parámetro

Descripción

Color predeterminado

Vista previa en Android

Vista previa en iOS

titleColor

Color del texto del título del cuadro de diálogo.

#000000

image

image

messageColor

Color del texto del mensaje del cuadro de diálogo.

#888888

image

image

primaryActionColor

Color del texto del botón de acción principal en un cuadro de diálogo con dos botones (derecha).

#FF6A00

image

image

secondaryActionColor

Color del texto del botón de acción secundaria en un cuadro de diálogo con dos botones (izquierda).

#000000

image

image

singleActionColor

Color del texto del botón de acción en un cuadro de diálogo con un solo botón.

#FF6A00

image

image

guideConfig

Parámetro

Descripción

Color predeterminado

Vista previa en Android

Vista previa en iOS

titleColor

Color del texto del título principal.

#3D3D3D

image

image

contentColor

Color del texto del contenido.

#333333

image

image

ocrConfig

Parámetro

Descripción

Color predeterminado

Vista previa en Android

Vista previa en iOS

borderColor

Color del borde del cuadro de escaneo o del área hueca.

#ffffff

image

image

titleColor

Color del texto de indicación en la parte superior de la página de reconocimiento.

#ffffff

image

image

albumLabelColor

Color del texto del botón del álbum.

#ffffff

image

image

takePhotoLabelColor

Color del texto del botón para alternar entre tomar foto y escanear.

#ffffff

image

image

floodLightBase64

Ícono de flash activado.

data:image/png;base64,...

image

image

unFloodLightBase64

Ícono de flash desactivado.

data:image/png;base64,...

image

image

autoScanBase64

Ícono del botón de escaneo automático.

data:image/png;base64,...

image

image

takeShootBase64

Ícono para cambiar al modo de captura de fotografía.

data:image/png;base64,...

image

image

albumBase64

Ícono del botón del álbum.

data:image/png;base64,...

image

image

takePhotoBase64

Ícono del botón para tomar fotografía.

data:image/png;base64,...

image

image

submitTitleColor

Color del texto de indicación para enviar.

#ffffff

image

image

submitBase64

Ícono del botón de envío.

data:image/png;base64,...

image

image

resultTitleColor

Color del título en la página de resultados.

#000000

image

image

resultTipColor

Color del texto de la barra de aviso superior en estado normal.

#000000

image

image

resultTipBgColor

Color de fondo de la barra de aviso superior en estado normal.

#EDEDED

image

image

resultErrorTipColor

Color del texto de la barra de aviso superior cuando la validación falla.

#C80000

image

image

resultErrorTipBgColor

Color de fondo de la barra de aviso superior cuando la validación falla.

#FFE0DC

image

image

resultErrorTipIconBase64

Ícono que indica un fallo de validación.

data:image/png;base64,...

image

image

resultInfoTitleColor

Color de los títulos de las entradas en el área de información.

#333333

image

image

resultInfoContentColor

Color del texto del cuadro de entrada en el área de información.

#999999

image

image

resultInfoContentBgColor

Color de fondo del cuadro de entrada en el área de información.

#F7F7F7

image

image

resultInfoBorderColor

Color del borde de un cuadro de entrada en el área de información cuando la validación falla.

#FF6A00

image

image

faceConfig

Parámetro

Descripción

Valor predeterminado

Captura de pantalla en Android

Captura de pantalla en iOS

titleColor

Color del texto de indicación en la parte superior de la página de reconocimiento facial.

#000000

image

image

tipColor

Color del texto de indicación dentro del marco de reconocimiento facial.

#000000

image

image

bgColor

Color de fondo de la página de reconocimiento facial.

#ffffff

image

image

progressStartColor

Color inicial de la barra de progreso circular.

#80ffffff

image

No compatible con iOS.

progressEndColor

Color final de la barra de progreso circular.

#FF6A00

image

image

nfcConfig

Parámetro

Descripción

Color predeterminado

Captura de pantalla en Android

Captura de pantalla en iOS

titleColor

Especifica el color del texto del título en la página de lectura NFC.

#3D3D3D

image

image

contentColor

Especifica el color del texto del cuerpo en la página de lectura NFC.

#3D3D3D

image

image

readStatusTextColor

Especifica el color del texto de estado en la ventana emergente de estado de lectura.

#3D3D3D

image

No aplica. Los cuadros de diálogo del sistema no se pueden modificar.

readStatusExitBase64

Imagen codificada en Base64 para el ícono de cierre en la ventana emergente de estado de lectura.

data:image/png;base64,...

image

No aplica. Los cuadros de diálogo del sistema no se pueden modificar.

inputTitleColor

Especifica el color del texto del título en la página de entrada de información.

#262626

image

image

inputLabelColor

Especifica el color del texto de las etiquetas en la página de entrada de información.

#333333

image

image

inputEditColor

Especifica el color del texto de los campos de entrada en la página de entrada de información.

#333333

image

image

inputEditHintColor

Especifica el color del texto de marcador de posición en los campos de entrada de la página de entrada de información.

#999999

image

image