Verifiera ett dokument med API:et
Skicka en PDF till VerifyPDF REST-API med din API-nyckel i API-KEY-headern. Varje verifiering förbrukar ett dokument och ger samma resultat som dashboarden.
VerifyPDF REST-API låter dina egna system verifiera dokument utan att någon öppnar dashboarden. Den här artikeln täcker flödet på en övergripande nivå. För alla detaljer om förfrågan och svar, använd referensen på /agents/.
Innan du börjar
- REST-API:et finns på abonnemangen Professional och Corporate. Det ingår inte i Basic eller på ett konto utan abonnemang. Se Abonnemang förklarade.
- Du behöver en API-nyckel. Se Skapa och hantera API-nycklar.
Det grundläggande flödet
- Skapa en API-nyckel i avsnittet Developers och kopiera den en gång.
- Skicka PDF:en till API:et med din nyckel i
API-KEY-headern. - Läs resultatet, som kommer tillbaka med samma förtroendepoäng och bedömning av bedrägeririsk som du ser i dashboarden. Se Läs ditt verifieringsresultat.
Varje API-verifiering förbrukar ett dokument från din månadskvot eller ditt förbetalda saldo, precis som en uppladdning i dashboarden. Se Hur förbetalda paket fungerar.
Lägg till ditt eget referens-id
Du kan koppla ett custom_id till en verifiering, till exempel ditt interna ärendenummer eller order-id. Det låter dig slå upp verifieringen senare med din egen referens. Varje custom_id måste vara unikt inom ditt konto.
En snabb illustration
På en övergripande nivå skickar en förfrågan PDF:en tillsammans med API-KEY-headern som håller din nyckel. Den exakta endpointen, förfrågningskroppen och svarsformatet finns i API-referensen på /agents/ och inuti avsnittet Developers i dashboarden. Använd dem för kopieringsklara exempel istället för att gissa.
Testa först, gå sedan live
Medan du bygger, använd en test-nyckel. Byt till en live-nyckel för riktiga verifieringar. Se Test- kontra live-API-nycklar.
Nästa steg
- Vill du få resultat pushade till dig istället för polling? Se Konfigurera webhooks.
- Behöver du hela referensen? Gå till /agents/.