API Resources

Description of Verify API Resources.

Below are the API resources available in the Verify API. For a full API reference, please see the Verify API Reference.

Resource

Description

/token

Oauth2 client credential-based authentication mechanism to retrieve a bearer token that's required to interact with any endpoints below throughout your transaction.

/slverify

Verifies the end user's attributes against the configured verification sources, and returns a list of assertions. Does not store any data in the Personal Data Service.

/otp

Initiates a OTP challenge based on input configuration. Can be SMS, Email, or Voice.

/doccapture/sendlink

Initiates mobile gov-ID capture process. Takes mobile number of user as input.

/doccapture/status

Checks for status on the doc capture process.

/api/doccapture/results

Gets results of document upload, which can then be used in /verify, /slverify, or /reverify.

/trustdevice

After a successful MFA event, this can be called to trust the device for future logins (ex. for MFA suppression)

/email

Send a user an email with an embedded OIDC verification link (prefilled data options available)*

/link

Generate an OIDC verification link (prefilled data options available)*

  • Requires special admin console permissions. Speak to your Solutions Architect to learn more.

📘

API Technical Reference

The AXN Verify API Reference includes all of the technical details you'll need to integrate your system.


What’s Next