Verificar un documento con la API

La API REST de VerifyPDF permite que tus propios sistemas verifiquen documentos sin que nadie abra el panel. Este artículo cubre el flujo a grandes rasgos. Para todos los detalles de la petición y la respuesta, usa la referencia en /agents/.

Antes de empezar

• La API REST está disponible en los planes Professional y Corporate. No se incluye en Basic ni en una cuenta sin plan. Consulta Los planes explicados.
• Necesitas una clave de API. Consulta Generar y gestionar claves de API.

El flujo básico

1. Crea una clave de API en la sección Desarrolladores y cópiala una vez.
2. Envía el PDF a la API con tu clave en la cabecera API-KEY de la petición.
3. Lee el resultado, que llega con la misma puntuación de confianza y la misma clasificación de riesgo de fraude que ves en el panel. Consulta Leer tu resultado de verificación.

Cada verificación por API consume un documento de tu cupo mensual o de tu saldo prepago, exactamente igual que una carga desde el panel. Consulta Cómo funcionan los paquetes prepago.

Añade tu propia referencia

Puedes añadir un custom_id a una verificación, por ejemplo tu número de caso interno o id de pedido. Eso te permite buscar la verificación más tarde por tu propia referencia. Cada custom_id debe ser único dentro de tu cuenta.

Una breve ilustración

A grandes rasgos, una petición envía el PDF junto con la cabecera API-KEY que lleva tu clave. El punto final exacto, el cuerpo de la petición y el formato de la respuesta están en la referencia de la API en /agents/ y dentro de la sección Desarrolladores del panel. Úsalos para tener ejemplos listos para copiar en vez de adivinar.

Prueba primero, luego pasa a producción

Mientras construyes, usa una clave de prueba. Cambia a una clave real para verificaciones reales. Consulta Claves de API de prueba y reales.

Próximos pasos

• ¿Quieres que los resultados se te envíen en vez de consultarlos? Consulta Configurar webhooks.
• ¿Necesitas la referencia completa? Ve a /agents/.