Een document verifiëren met de API
Stuur een PDF naar de VerifyPDF REST API met je API-sleutel in de API-KEY header. Elke verificatie verbruikt één document en geeft hetzelfde resultaat als het dashboard.
Met de VerifyPDF REST API kunnen je eigen systemen documenten verifiëren zonder dat iemand het dashboard opent. Dit artikel behandelt het verloop op hoofdlijnen. Voor de volledige details van verzoek en antwoord, gebruik de referentie op /agents/.
Voordat je begint
- De REST API is beschikbaar op de abonnementen Professional en Corporate. Hij zit niet in Basic of een account zonder abonnement. Zie Abonnementen uitgelegd.
- Je hebt een API-sleutel nodig. Zie API-sleutels genereren en beheren.
Het basisverloop
- Maak een API-sleutel aan in de Developers-sectie en kopieer hem één keer.
- Stuur de PDF naar de API met je sleutel in de
API-KEYrequest header. - Lees het resultaat, dat terugkomt met dezelfde vertrouwensscore en beoordeling van het frauderisico die je in het dashboard ziet. Zie Je verificatieresultaat lezen.
Elke API-verificatie verbruikt één document uit je maandelijkse tegoed of prepaid saldo, precies als een upload in het dashboard. Zie Hoe prepaid bundels werken.
Voeg je eigen referentie-id toe
Je kunt een custom_id aan een verificatie koppelen, bijvoorbeeld je interne dossiernummer of order-id. Daarmee kun je de verificatie later opzoeken met je eigen referentie. Elke custom_id moet uniek zijn binnen je account.
Een korte illustratie
Op hoofdlijnen stuurt een verzoek de PDF samen met de API-KEY header die je sleutel bevat. Het exacte endpoint, de request body en het antwoordformaat staan in de API-referentie op /agents/ en in de Developers-sectie van het dashboard. Gebruik die voor kant-en-klare voorbeelden in plaats van te gokken.
Test eerst, ga dan live
Terwijl je bouwt, gebruik je een test-sleutel. Stap over op een live-sleutel voor echte verificaties. Zie Test- versus live-API-sleutels.
Wat je daarna kunt doen
- Wil je dat resultaten naar je worden gepusht in plaats van pollen? Zie Webhooks instellen.
- Heb je de volledige referentie nodig? Ga naar /agents/.