> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Información de identidad y verificación de validez API Integración
> Identity Authentication 集成指南 - XHuoAPI
Este documento presentará una descripción de la integración de la API de verificación de información de identidad y validez, que se puede utilizar para verificar la autenticidad y consistencia del nombre, número de identificación y la validez de la identificación.
## Proceso de Solicitud
Para utilizar la API, primero debe ir a la página correspondiente de la [API de verificación de información de identidad y validez](https://api.xhuoapi.ai/documents/667017a4-017f-4af0-870e-807034f70632) para solicitar el servicio correspondiente. Una vez en la página, haga clic en el botón "Acquire", como se muestra en la imagen:
Si aún no ha iniciado sesión o registrado, será redirigido automáticamente a la página de inicio de sesión que lo invita a registrarse e iniciar sesión. Después de iniciar sesión o registrarse, será redirigido automáticamente a la página actual.
En la primera solicitud, se le otorgará un límite gratuito que le permitirá utilizar la API de forma gratuita.
## Uso Básico
Primero, comprenda la forma básica de uso, que consiste en ingresar el enlace de la imagen de la identificación, y podrá obtener el resultado de verificación procesado. Primero, necesita pasar un campo `name`, y luego podrá completar el contenido correspondiente en la interfaz, como se muestra en la imagen:
Como puede ver, aquí hemos configurado los Encabezados de Solicitud, que incluyen:
* `accept`: el formato de respuesta que desea recibir, aquí se establece como `application/json`, es decir, formato JSON.
* `authorization`: la clave para llamar a la API, que puede seleccionar directamente después de solicitar.
Además, se ha configurado el Cuerpo de Solicitud, que incluye:
* `name`: nombre.
* `id_card`: número de identificación.
* `image_url`: enlace de la imagen facial que necesita ser procesada.
* `validity_end`: fecha de vencimiento de la identificación, formato: YYYYMMDD, use "00000000" para largo plazo;
* `validity_begin`: fecha de inicio de validez de la identificación, formato: YYYYMMDD.
* `encryption`: opcional, parámetros de cifrado de campos sensibles (si necesita enviar texto cifrado).
Después de seleccionar, puede notar que también se ha generado el código correspondiente a la derecha, como se muestra en la imagen:
Haga clic en el botón "Try" para realizar la prueba, como se muestra en la imagen anterior, aquí hemos obtenido el siguiente resultado:
```json theme={null}
{
"result": "0",
"description": "Consistente"
}
```
El resultado devuelto tiene varios campos, que se describen a continuación:
* `result`, código de resultado de autenticación, la situación de cobro es la siguiente.
* Códigos de resultado de cobro:
* 0: Nombre y número de identificación coinciden
* -1: Nombre y número de identificación no coinciden
* Códigos de resultado sin cobro:
* -2: Número de identificación ilegal (longitud, dígito de verificación, etc. incorrectos)
* -3: Nombre ilegal (longitud, formato, etc. incorrectos)
* -4: Excepción del servicio de base de datos de documentos
* -5: No hay registro de este número de identificación en la base de datos
* -6: Sistema de comparación autoritativa en actualización, por favor intente más tarde
* -7: Número de autenticaciones excede el límite diario.
* `description`, resultado de la verificación del nombre y número de identificación.
Se puede ver que el nombre, número de identificación y la validez de la identificación tienen autenticidad y consistencia.
Además, si desea generar el código de integración correspondiente, puede copiarlo directamente, por ejemplo, el código de CURL es el siguiente:
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"name": "***",
"id_card": "***",
"validity_begin": "***",
"validity_end": "***"
}'
```
El código de integración en Python es el siguiente:
```python theme={null}
import requests
url = "https://api.xhuoapi.ai/v1/identity/idcard/check-2e"
headers = {
"accept": "application/json",
"authorization": "Bearer {token}",
"content-type": "application/json"
}
payload = {
"name": "***",
"id_card": "***",
"validity_begin": "***",
"validity_end": "***"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
```
## Manejo de Errores
Al llamar a la API, si encuentra un error, la API devolverá el código de error y la información correspondiente. Por ejemplo:
* `400 token_mismatched`: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
* `400 api_not_implemented`: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
* `401 invalid_token`: No autorizado, token de autorización inválido o faltante.
* `429 too_many_requests`: Demasiadas solicitudes, ha excedido el límite de tasa.
* `500 api_error`: Error interno del servidor, algo salió mal en el servidor.
### Ejemplo de Respuesta de Error
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## Conclusión
A través de este documento, ha aprendido cómo utilizar la API de verificación de información de identidad y validez para verificar la autenticidad y consistencia del nombre, número de identificación y validez de la identificación. Esperamos que este documento le ayude a integrar y utilizar mejor esta API. Si tiene alguna pregunta, no dude en ponerse en contacto con nuestro equipo de soporte técnico.