Overview

The Verify module gives you a couple of ways to build identity verification into your own systems. There's a RESTful application programming interface (API) that covers every function the module can perform, and a responsive HTML5 JavaScript widget that renders the verification screens for you.

An API is simply a way for two systems to talk to each other. Verify's APIs are built on standard technologies, RESTful HTTP and JSON Web Tokens (JWTs), so they work happily across all the major environments your developers are likely to be using, including Java, .NET, Python, PHP, and Ruby. There's nothing exotic to learn, just the tools your team already knows.

There are two APIs to be aware of: the Admin API, which your back-end systems use to manage customers and kick off verification requests, and the Verification API, which the customer's own device uses to complete a verification and submit their documents. They work as a pair, each doing a different job at a different stage.

‍

Start with the JavaScript widget
‍Where you can, we recommend using the JavaScript widget rather than building your own verification screens from scratch. It renders the whole client-side user interface (UI) for you, which keeps your implementation effort to a minimum and means you don't have to design and maintain the verification flow yourself.

‍

The Admin API

The Admin API is the one your existing customer-facing system talks to, whether that's your website, an online portal, or your mobile app. It runs behind the scenes, server to server, and handles the setup work before a customer ever sees a verification screen.

Use the Admin API when you need to:

• Check a customer's current verification status.
• Create new customers or members.
• Create a verification request, ready for the customer to complete.

In short, it's how your platform gets a verification ready to go.

‍

The Verification API

Once a verification request exists, the Verification API takes over. This is the API that the end user's own device talks to, their mobile phone or PC, when they actually complete the verification and submit their documents.

The Verify JavaScript UI uses the Verification API under the hood, so if you go with the widget, this part is largely handled for you. If you'd rather build your own experience, you can call the Verification API directly and create a custom UI that fits your brand and flow exactly.

That's the full picture: the Admin API sets a verification up, the Verification API gets it done, and the JavaScript widget is the quickest way to put a polished verification screen in front of your customers without building one yourself.

‍

Need the full technical specification?
‍For more detail on the API deployment specification, get in touch with your System Administrator or your ChandlerCX Growth Team representative, who can provide the complete technical specification.