Client Onboarding

Suggest Edits

There are three environments for the Interac Hub:

  • Interac Dev Portal (Hub V2 Developer Sandbox): This is a standalone experimental test environment. You may perform self-onboarding by registering to the Dev Portal and creating Projects. See Getting Started for more details.
  • Interac Hub V2 Preprod: This is the non-prod Hub environment. To create a client ID (analogous to a Project in the Dev Portal), please complete the below onboarding checklist and reach out to your client representative. Self-service onboarding is currently not possible in this environment.
  • Interac Hub V2 Prod: This is the prod Hub environment. To create a client ID (analogous to a Project in the Dev Portal), please complete the below onboarding checklist and reach out to your client representative. Self-service onboarding is currently not possible in this environment.

Client registration is done through the Integration team. If you are not currently engaged with the Integration team please reach out to your business contact for further instructions.

Projects vs. client IDs: The Interac Dev Portal is open for all as an experimental playground. Developers may create client IDs in that environment by creating new projects on the Dev Portal user interface (i.e. self-service onboarding).

The Hub Preprod and Prod environments are restricted and open to developers who have signed business agreements. There is no Portal user interface for self-onboarding. Access to these environments require submission of an onboarding form (see below) and a request opened to our backend onboarding team to programmatically create a client ID in these environments.

Partner Onboarding Checklist

This checklist is required to create a client ID in the Interac Hub preprod/prod environments. Once the onboarding has completed the following will be provided to begin integration:

  • RP client_id to be used in API requests (e.g. 'acme_widgets')
  • RP OIDC scope names (e.g. 'openid general_scope')
  • Hub OpenID Connect Discovery .well-known URL (e.g. 'https://hub.baseenv.url/.well-known/openid-configuration')

Checklist Items

Please reach out to your client representative for a copy of the full checklist with descriptions and examples. At a high level, the following details will be collected.

  • Entity Name (English)
  • Entity Name (French)
  • JWKS URL
  • Redirect URLs
  • RP Branding Logos
    • Small Logo (1:1 aspect ratio; 200px:200px)
    • Big Logo (55:11 aspect ratio; 255px:55px)
    • Favicon (1:1 aspect ratio; 48px:48px)
  • OIDC Scope Configuration
    • Scope names
    • sessionTimeoutOverride flag
    • asyncResultDelivery flag
  • Subject Matching / Enable PAR (pushed authorization requests)
    • acceptPartialResult flag
    • hidePII flag
  • Interac Verification Service Scope Configuration
    • IVS bundle(s) and fields
  • Interac Document Verification Service Scope Configuration
    • Supported document types and fields
    • allowExpiredDocs flag
    • allowPartialResults flag

Updated 5 months ago