Build identity capture and verification into your product.

Where to start

1. Read the API overview

   How the API is organised, how every call authenticates, and what each endpoint family does.

2. Ask for an evaluation key

   Tell us what you are building on the developer form. An evaluation is up to 30 days and no more than 100 API transactions, for internal testing only.

3. Get your key and portal access together

   The portal gives you the API playground, the documentation and the support ticket system from day one.

4. Make your first request

   Copy a sample from any endpoint page, add your key, and run it from your own environment or the playground.

Start here

• APX-Verify API overview

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

• Evaluating the API

  What an evaluation key gives you, for how long, and how to ask for one.

• What the APX-Verify cloud keeps

  APX-Verify APIs are designed to protect sensitive identity data throughout the cloud verification transaction, from encrypted request through encrypted result delivery.

Read and authenticate a document

• Process Document From Files

  Sending an identification document for full processing in the cloud according to the requested settings in the query parameters.

• Process Barcode

  Send an AAMVA-compliant barcode for data extraction and verification of the authenticity of the encoded information.

• Perform Two Factor Authentication

  POST /v1/Document/PerformTwoFactorAuthentication

Check the person

• IDV Match

  POST /v1/IdentityVerification/IDVMatch

• AAMVA Driver License Verification

  POST /v1/IdentityVerification/AAMVADriverLicenseVerification

• Knowledge Based Authentication

  POST /v1/IdentityVerification/KnowledgeBasedAuthentication

• Age Verification

  Finding a person's date of birth based on their full name and residential address.

• Reverse Email Lookup

  POST /v1/IdentityVerification/ReverseEmailLookup

• Reverse Phone Lookup

  GET /v1/IdentityVerification/ReversePhoneLookup

• Get Verification Message Status

  Retrieves the status of a sent verification text message using the Long Polling method.

• Update Verification Message Status

  Performs a validation attempt for a sent text message.

Match the face, capture remotely

• Process Facial Recognition And Liveness From Files

  The purpose of this endpoint is to perform a comparison between two images - typically a selfie and an image taken from an identity document. The endpoint verifies whether the person in both images is the same and allows performing a liveness check on the selfie image.

• Generate One Time Link

  Generates a one-time access link based on the specified request parameters.

• Wait For Scan Results

  Waits asynchronously for the results of a scan operation associated with the specified transaction identifier.

Drive a scanner

Trigger a scan on a networked IDSnap GC2500e from your own software.

• Initiate Remote Scan

  Initiate remote scan based on the specified request parameters.

Enrich contact data, check the service

• Basic Lead Enhancement

  Enrichment of the contact information - phone numbers and email addresses - of the person whose details were entered in the body of the request.

• Implicit Lead Enhancement

  POST /v1/LeadGeneration/ImplicitLeadEnhancement

• Lead Enhancement (Lead Generation)

  POST /v1/LeadGeneration/LeadEnhancement

• Lead Enhancement (Identity Verification)

  POST /v1/IdentityVerification/LeadEnhancement

• Health Check

  GET /v1/HealthCheck

From the knowledge base

• What APX-DFA actually checks

  APX-DFA returns Pass, Warning or Fail on a scanned identity document. This article sets out the eleven checks behind that result, what each one looks at, and why each one catches a different kind of problem.