/authorize

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

  • The /authorize endpoint (discoverable via the /well-known endpoint) is the primary initiation for a user's verification process via the AXN Gateway integration option. To use this method, you will be generating an "OIDC Authorize URL" and leveraging browser redirects to the verify your users.
  • For more information on AXN Gateway and OIDC in general, see Overview.

Endpoints

Setup

  • Since OIDC is an industry standard, we recommend you use your applications default OIDC settings (most modern applications inherently support OIDC and the parameters above so most of these query parameters are out-of-the-box configurations).
  • Ensure the required fields above are filled in via your plugin.

Usage

  • Once the URL is generated, simply perform a browser redirect to the URL. The browser will bring you to the IDW screen for the user to perform identity verification (note: if an IDP scope is included, the user will perform authentication at the IDP first).

After completion

  • Once the user completes the IDW flow, a 1 time code will be sent to the Relying Party's redirect URL. The next step in the process continues at the /token call (see https://docs.iddataweb.com/reference/token)
📘

Note: Browser redirect

The above call should be made through a browser, not as a backchannel API call.

🚧

Note: Redirect URL

When the user authentication and verification is complete, the response listed above will be sent to your application's Redirect URL.

Query Params
string

Required. Your API key from AXN Admin.

string

Required. Your redirect URI registered in AXN Admin.

string

Required. A list of OIDC parameters delimited by '+'. See https://docs.iddataweb.com/docs/scopes for more details.

string
Defaults to code

Required. Indicates a 3L Oauth flow.

string

Optional. An encrypted JSON Web Token (JWT) used to pass user information to IDW securely. Ssee https://docs.iddataweb.com/docs/prefill-pii-from-source for more details

string

Optional (recommended) A random string generated by your application, which can be re-validated later to prevent CSRF attacks.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
text/plain
application/json