Este tema describe la API del servicio Credential Recognition. Esta API síncrona permite enviar una imagen de credencial o un archivo PDF, extraer información clave mediante inteligencia artificial y detectar falsificaciones. La API devuelve un resultado de inmediato.
Referencia de la API
Nombre de la API: CredentialRecognitionIntlV2
Descripción: extrae información clave de una imagen de credencial o de un archivo PDF mediante inteligencia artificial y es compatible con la detección de falsificaciones.
Método de solicitud: POST
Protocolo: HTTPS
-
Límite de QPS: cada API tiene su propio límite de QPS. Para obtener más información, consulte QPS limits of ID Verification server-side APIs.
-
Endpoints:
NotaVentajas 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 el servidor de su aplicación está desplegado en la misma región, utilice el endpoint interno para acceder al servicio ID Verification. Esto mejora la seguridad y la estabilidad.
Optimización del acceso desde el extranjero: los entornos de red internacionales suelen ser complejos. Consulte Optimize server network latency para ajustar su integración, reducir la latencia de la red y disminuir las solicitudes con errores.
Singapore
Endpoint público:
cloudauth-intl.ap-southeast-1.aliyuncs.comEndpoint interno:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
La función de detección de falsificaciones de Credential Recognition es un producto de predicción basado en inteligencia artificial. Alcanza una precisión del 90 % en conjuntos de datos de prueba internos. La precisión real varía según los escenarios de muestra.
Detectar alteraciones en imágenes generadas digitalmente resulta más difícil. El rendimiento de detección es mejor con imágenes capturadas por una cámara nativa que con aquellas creadas de forma digital.
Se recomienda no utilizar la detección de falsificaciones como único método para verificar la autenticidad de una credencial. Úsela como comprobación complementaria o como herramienta para mejorar la eficiencia de la revisión manual.
Esta función se usa ampliamente en escenarios de revisión de documentos electrónicos, como la adquisición de pagos financieros y el registro de comercios de comercio electrónico, para agilizar la revisión manual. Si necesita aplicarla a otros escenarios, comuníquese con su administrador de cuenta.
Depuración e integración en línea
Antes de depurar e integrar, lea el documento Use OpenAPI para aprender a invocar las API en la plataforma OpenAPI y obtener el SDK.
Utilice OpenAPI Explorer para invocar directamente esta API durante la depuración y generar ejemplos de código del SDK.
Parámetros de solicitud
El archivo correspondiente al parámetro CredentialOcrPictureBase64, CredentialOcrPictureUrl o CredentialOcrPictureFile debe cumplir con los siguientes requisitos:
Método de envío: elija uno de los tres métodos de carga.
Formato de archivo: cuando
FileInputType=IMAGE(valor predeterminado), los formatos compatibles son PNG, JPG, JPEG, BMP y WebP. CuandoFileInputType=PDF, el formato compatible es PDF.Dimensiones del archivo: tanto el ancho como la altura deben ser mayores a 15 píxeles y menores a 8,192 píxeles. La relación de aspecto debe ser menor a 50.
Tamaño del archivo: no puede superar los 10 MB.
Para obtener mejores resultados de reconocimiento, se recomienda que tanto el ancho como la altura de la imagen sean mayores a 500 píxeles.
Los archivos grandes aumentan el tiempo de respuesta de la API. Se recomienda usar archivos menores a 3 MB.
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
ProductCode | String | Sí | El valor debe ser CREDENTIAL_RECOGNITION. | CREDENTIAL_RECOGNITION |
CredentialOcrPictureBase64 | String | No. Especifique solo uno de los tres parámetros de carga. | La imagen o el archivo PDF codificado en Base64. Si utiliza este método, compruebe el tamaño del archivo y no envíe uno demasiado grande. | base64 |
CredentialOcrPictureUrl | String | Una URL HTTP o HTTPS de acceso público que apunte a la imagen o al archivo PDF. | https://***.jpg | |
CredentialOcrPictureFile | InputStream | El flujo de archivo de la credencial. Para conocer los detalles de integración, consulte Special Scenarios: File Uploading Through the Advance API. | ||
FileInputType | String | No | El tipo de archivo de entrada.
| IMAGE |
DocType | String | Sí | El tipo de credencial:
| 01 |
OcrArea | String | Sí | El tipo de extracción:
| 0101 |
FraudCheck | String | Sí | Habilita o deshabilita la detección de alteraciones.
| true |
CheckRuleConfig | String | No | Una cadena JSON que especifica las reglas de validación de campos. | |
OcrValueStandard | String | No | Indica si se habilita la estandarización de los resultados de OCR.
| 0 |
OcrTranslation | String | No | Indica si se habilita la traducción.
| 0 |
Parámetros de respuesta
Parámetro | Tipo | Descripción | Ejemplo | |
HTTP Status Code | Integer | El código de estado HTTP. | 200 | |
HTTP Body | RequestId | String | El identificador de la solicitud. | 130A2C10-B9EE-4D84-88E3-5384FF039**** |
ResultObject.TransactionId | String | Un identificador único para el proceso de verificación. | hksb7ba1b28130d24e015d694361b**** | |
Code | String | El código de retorno. Para obtener más información, consulte Server-side HTTP status codes. Importante
| Success | |
Message | String | El mensaje de respuesta. | success | |
ResultObject.Success | String | El resultado de la extracción:
| S | |
ResultObject.SubCode | String | La descripción del resultado de la verificación. Para obtener más información, consulte ResultObject.SubCode error codes. | 200 | |
ResultObject.ExtIdInfo | String | Para conocer el formato JSON, consulte el ejemplo de la derecha. Para obtener más información, consulte ResultObject.ExtIdInfo. |
| |
Códigos de error de ResultObject.SubCode
|
Código de error |
Facturación |
Descripción |
|
200 |
Sí |
Extracción exitosa. |
|
204 |
Sí |
La información clave no cumplió con las reglas de validación especificadas en CheckRuleConfig. |
|
211 |
Sí |
La calidad o resolución del archivo es deficiente. Asegúrese de que el archivo sea nítido, tenga buena exposición, esté completo, sin obstrucciones y sin inclinaciones significativas. |
|
212 |
Sí |
La comprobación contra suplantación detectó un riesgo. Esto se debe a indicadores como fotografías de pantalla, alteraciones o fotocopias. |
|
213 |
Sí |
Tipo de archivo incorrecto. Asegúrese de que el tipo de archivo coincida con el parámetro DocType. |
ResultObject.ExtIdInfo
Parámetro | Tipo | Descripción | Ejemplo |
recInfo | String | La información clave extraída. Nota Este campo queda vacío si la extracción falla. |
|
spoofInfo | String | El resultado de la comprobación contra suplantación, que incluye la evaluación y el tipo de riesgo:
| Se devuelve cuando |