APX-Verify API overview

How the APX-Verify API is organised, how every call authenticates, how keys are issued, and where to start.

The APX-Verify API is one API-first platform: document capture, forensic authentication, identity-data matching, biometric matching, mDL and compliance screening. Take the whole workflow, or only the modules you need.

Base URL

Every path in this documentation is relative to the API base URL:

{{API.SANDBOX_BASE_URL}}

The interactive reference generated from the live specification is at {{API.DOCS_URL}}.

Authentication

Every call carries an API key in a request header:

x-api-key: YOUR_API_KEY

How you get a key

  1. A key is issued to a company, by a person at Acupixel, after a conversation. There is no self-service sign-up.
  2. Every call consumes paid transactions. An evaluation key carries a small number of free transactions for testing.
  3. An evaluation is up to 30 days and no more than 100 API transactions, for internal testing only.
  4. Your key and your portal access arrive together, so you get the API playground, this documentation and the support ticket system at the same moment.

To ask for an evaluation key, use the developer contact form.

What the API covers

The live API exposes 20 endpoints, grouped by the question each one answers:

  • Read and authenticate a document: document processing, barcode processing, chip-based two-factor authentication.
  • Check the person: IDV Match, AAMVA driver licence verification, knowledge-based authentication, age verification, reverse email and reverse phone lookup, and SMS verification.
  • Match the face: facial recognition and liveness.
  • Capture remotely: AcuCapture one-time links and scan results.
  • Drive a scanner: remote scan initiation on a networked scanner.
  • Enrich contact data: lead enhancement.
  • Check the service: health check.

Each endpoint has its own reference page, with parameters, request body and static code samples in curl, C#, Python and JavaScript.

No live calls from this documentation

The samples here are static text. Running a request spends real transactions, so requests are run from the API playground inside the portal, with your own key.