Add Redirect URLs (OIDC)

For Gateway (OIDC), a redirect URL denotes where your user will return to after completing verification through your IDDataWeb-hosted verification workflow. You can add Redirect URLs in two ways:

  1. At Workflow Level - this adds the redirect URL to all services in the specified workflow.
  2. At Service Level - this adds the redirect URL to just one service.
    📘

    For the time being, Service Level Redirect URL still live in the legacy console. Please refer to the legacy docs.

Add Redirect URL at Workflow Level

In Admin, go to Workflows > Your Workflow

Go to the Details tab > Integration page > Redirects

With your Workflow open, towards the bottom of the screen, click Add new redirect URL, then choose type and enter the new URL.


Redirect Types




  • Static endpoint — Allows redirecting users to a system-defined endpoint.
  • Custom landing page — Allows redirecting users to a custom landing page path within the client application.
  • Customer defined URL — Allows redirecting users to a fully qualified external URL.


Redirect URL Types

Redirect URL types determine where users are sent after completing a flow. Each redirect entry must be assigned a Redirect Type, which defines how the destination URL is selected, constructed, and validated.

Overview

The platform supports three redirect URL types:

Redirect TypeUse WhenURL Format
Static EndpointYou want to redirect users to a supported platform-defined endpoint.System-defined endpoint, such as /IDToken
Custom Landing PageYou want to redirect users to a page within your client application.Relative path, such as /display/pagename
Customer Defined URLYou want to redirect users to a fully qualified external destination.Full URL, such as https://customer-domain.com/verification-complete

Static Endpoint

A Static Endpoint redirects users to a system-defined endpoint provided by the platform. These endpoints represent supported platform response paths and are selected from a predefined list.

Examples

/IDToken
/viewEndpoint

Configuration Behavior

When configuring a Static Endpoint redirect:

  1. Select Static Endpoint from the Redirect Type dropdown.
  2. Select one of the available system endpoints.
  3. Save the redirect configuration.

No manual URL entry is required. The destination is determined by the selected platform endpoint.

Notes

Static endpoints are managed by the platform. Only endpoints available in the dropdown are supported for this redirect type.

Custom Landing Page

A Custom Landing Page redirects users to a relative path within your client application. The path you provide is appended to the configured base domain for the client.

Example

/display/pagename

Configuration Behavior

When configuring a Custom Landing Page redirect:

  1. Select Custom Landing Page from the Redirect Type dropdown.
  2. Enter the relative landing page path.
  3. Save the redirect configuration.

The platform appends the relative path to the configured base domain.

Example Result

If the configured base domain is:

https://customer-domain.com

And the configured landing page path is:

/display/pagename

The resulting redirect destination is:

https://customer-domain.com/display/pagename

Notes

Use this option when the redirect target is hosted within your own client application and can be represented as a relative path.

Customer Defined URL

A Customer Defined URL redirects users to a fully qualified external URL. This option is used when the destination is not represented by a platform endpoint or a relative client application path.

Example

https://customer-domain.com/verification-complete

Configuration Behavior

When configuring a Customer Defined URL redirect:

  1. Select Customer Defined URL from the Redirect Type dropdown.
  2. Enter the full destination URL.
  3. Save the redirect configuration.

The URL must pass the platform hostname validation rules before it can be used.

URL Requirements

Customer Defined URLs must be fully qualified and include the protocol and hostname.

Valid example:

https://customer-domain.com/verification-complete

Invalid example:

/verification-complete

A relative path should be configured as a Custom Landing Page, not as a Customer Defined URL.

Redirect Type Selection Guide

Use the following guidance when selecting a redirect type:

ScenarioRecommended Redirect Type
Redirect to a platform-supported response pathStatic Endpoint
Redirect to a page within the configured client application domainCustom Landing Page
Redirect to a complete external URLCustomer Defined URL

Validation Summary

Redirect TypeManual URL InputValidation
Static EndpointNoMust be selected from the supported system endpoint list.
Custom Landing PageYes, relative path onlyPath is appended to the configured base domain.
Customer Defined URLYes, full URL requiredURL must pass hostname validation rules.