Este tema describe cómo llamar a la API CheckResult para obtener los resultados de verificación de la solución ID_OCR_PRO.
API
- API name: CheckResult
- Request method: HTTPS POST
-
Description: Cuando el servidor recibe una notificación que indica que la autenticación finalizó, llame a esta API para obtener el estado y la información correspondientes. Esta notificación se envía cuando el código de resultado del cliente es 1001 o 1002. Para más información, consulte Native SDK client result codes and sub-codes.
ImportanteEl servicio ID Verification almacena los resultados de verificación durante 30 días de forma predeterminada. Obténgalos dentro de este periodo, ya que después se eliminan automáticamente.
-
Límite de QPS: cada API tiene su propio límite de QPS. Para más información, consulte QPS limits of ID Verification server-side APIs.
-
Service endpoints
Nota
Ventajas del acceso por red interna: una red interna es una red de comunicación privada que conecta los productos de Alibaba Cloud dentro de la misma región. Si su servidor de aplicaciones está desplegado en la misma región, utilice el endpoint interno para acceder al servicio ID Verification y mejorar la seguridad y la estabilidad.
Optimización del acceso desde el extranjero: los entornos de red internacionales pueden ser complejos. Consulte Optimize server network latency para ajustar su integración y reducir la latencia de red y los errores en las solicitudes.
Asia Pacific SE 1 (Singapore)
Endpoint público:
cloudauth-intl.ap-southeast-1.aliyuncs.comEndpoint interno:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
Asia Pacific SE 5 (Jakarta)
Endpoint público:
cloudauth-intl.ap-southeast-5.aliyuncs.comEndpoint interno:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
China (Hong Kong)
Endpoint público:
cloudauth-intl.cn-hongkong.aliyuncs.comEndpoint interno:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
Asia Pacific SE 3 (Kuala Lumpur)
Endpoint público:
cloudauth-intl.ap-southeast-3.aliyuncs.comEndpoint interno:
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
Depuración e integración en línea
Antes de depurar e integrar, lea el documento Use OpenAPI para aprender a llamar a las API en la plataforma OpenAPI y obtener el SDK.
Utilice OpenAPI Explorer para llamar directamente a esta API durante la depuración y generar ejemplos de código del SDK.
Notas de uso
Almacenamiento del identificador de transacción:
TransactionIdes el único identificador confiable de un registro de verificación en el servidor. Debe vincularlo a un identificador de negocio y almacenarlo de forma persistente en su servidor.Retención de registros y cumplimiento normativo: los registros de resultados de verificación se almacenan durante 30 días de forma predeterminada y luego se eliminan automáticamente. Consulte los resultados dentro de este periodo y almacene los datos relevantes según sus requisitos de cumplimiento.
Condiciones para devolver la imagen de autenticación: la imagen de autenticación se devuelve únicamente si
IsReturnImage=Yy el escaneo facial es exitoso. Dado que el contenido en Base64 es extenso, mantenga el valor predeterminadoNsi no necesita mostrar ni almacenar la imagen.Lógica para determinar el resultado de autenticación:
Code=Successsolo indica que la llamada a la API fue exitosa. El resultado final de la autenticación lo determinan los camposResult.PassedyResult.SubCode.Tolerancia a fallos en el análisis sintáctico de campos OCR: los campos OCR, la cantidad de páginas del documento y los atributos faciales pueden variar según el tipo de documento, las capacidades de la región y la configuración del SDK. Su cliente debe gestionar los campos faltantes o nuevos durante el análisis sintáctico.
Distribución de campos
La estructura principal de retorno de CheckResult, así como los campos de resultado de prueba de vida y de resultado OCR, son iguales para las integraciones con App SDK y Web SDK.
|
Categoría |
Campo |
Descripción |
|
Salida común |
Respuesta general, resultado de autenticación, |
Estos campos se pueden devolver en ambos modos de integración, según el flujo de verificación y la configuración de InitializeV2. |
|
Específico de Web SDK |
|
Devuelve la política de respaldo real cuando ocurre un retroceso por compatibilidad durante la verificación. |
|
Específico de la aplicación |
Ninguna |
Ninguna |
Request parameters
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
MerchantBizId | String | Sí | Identificador de negocio único del comerciante, compuesto por 32 letras y dígitos. Este valor debe coincidir con el utilizado en la solicitud InitializeV2. | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | Sí | Identificador de autenticación único que devuelve una llamada exitosa a la API init. Para evitar alteraciones, obtenga siempre este valor desde el almacenamiento de su servidor y no confíe en el valor enviado desde el cliente. | hksb7ba1b28130d24e015d6**** |
IsReturnImage | String | No | Especifica si se devuelven los datos de la imagen de verificación (incluidas las fotografías del documento):
| Y |
Response parameters
Parámetro | Tipo | Descripción | Ejemplo | |
HTTP Status Code | Integer | Código de estado HTTP. | 200 | |
HTTP Body | RequestId | String | Identificador de la solicitud, utilizado para solucionar problemas. | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Code | String | Código de respuesta del servidor. Para más información, consulte Server-side HTTP Status Codes. | Success | |
Message | String | Descripción detallada del código de respuesta. | success | |
Result.Passed | String | Resultado final de la verificación:
| Y | |
Result.SubCode | String | Código detallado del resultado de verificación. Para más información, consulte Result.SubCode Subcodes. | 200 | |
Result.ExtIdInfo | String | Resultados de OCR del documento y de detección contra suplantación. Para más información, consulte Result.ExtIdInfo. | | |
Result.ExtInfo | String | Información adicional de verificación, que incluye principalmente el método de respaldo real para la verificación H5 móvil. Para más información, consulte Result.ExtInfo. | | |
Result.ExtIdInfo
Parámetro | Tipo | Descripción | Ejemplo |
ocrIdPassed | String | Resultado final de la etapa de OCR del documento:
| N |
ocrDocType | String | Se devuelve únicamente cuando el parámetro | CHN01001 |
ocrIdInfoData | Map<String,Object> | Resultados detallados de cada página del documento. La clave es el número de página y el valor se describe en ocrIdInfoData.{page} single-page fields. Los números | |
ocrIdEditInfo | String | Este campo contiene la información de los campos OCR del documento que el usuario envió después de editarla en la página de resultados de OCR. Se devuelve cuando el cliente está configurado para habilitar la página de edición de resultados de OCR (ShowOcrResult). | |
ocrStandardData | String | Información estandarizada de los campos OCR del documento. Nota Se devuelve únicamente si este tipo de identificación es compatible y | |
Campos de página única ocrIdInfoData.{page}
Parámetro | Tipo | Descripción | Ejemplo |
idImage | String | Imagen del documento de identidad procesada por OCR en formato Base64. Se devuelve únicamente cuando | Formato Base64 |
ocrIdPassed | String | Resultado de OCR de la página actual del documento:
| N |
ocrIdInfo | String | Información de los campos OCR de la página actual del documento. Este campo queda vacío si el OCR falla. Los campos específicos varían según el tipo de documento. Para consultar la lista de campos, vea Document OCR Fields. | |
spoofInfo | String | Resultado de la detección contra suplantación, que incluye la decisión de riesgo y los tipos de riesgo: Nota La detección de suplantación de tarjetas se habilita únicamente cuando IdSpoof = Y en la solicitud Initialize. De lo contrario, spoofResult se establece en N y spoofType queda vacío.
| |
Result.ExtInfo
Parámetro | Tipo | Descripción |
procedurePriority | String | Método de respaldo real utilizado para la verificación H5 móvil:
|
Result.SubCode subcodes
|
Subcódigo |
Con costo |
Descripción |
|
200 |
Sí |
Verificación aprobada. |
|
212 |
Sí |
[Solución de documentos] Se detectó un riesgo durante la comprobación contra suplantación del documento. Esto puede deberse a actividades de alto riesgo, como una recaptura de pantalla, una alteración digital o el uso de una fotocopia. |