Register Open Banking - Field Descriptions

redirect_uri

The URI where the customer is to be redirected to when they’ve completed Open Banking registration and connected their financial account.

String

Yes

is_hosted_in_mobile_app

Enables you to associate your Mastercard Portal Connect experience with the account. Add your unique experience GUID to the experience field in the request to do this.

If the link is going to be displayed in a Mobile App, then it should be set as true. This is to support an optimal experience in which the URL link is generated / presented.

Boolean

4

5

Yes

application_id

Used by OAuth partners (such as Chase) to display correct client (application) name and description in the respective OAuth partner login screen.

For testing purposes in UAT, your Thredd Implementations manager provides a generic ID.

For production, applicationId will be provided when your application is registered with your OAuth partners. Your Thredd Implementation manager will guide you through this process.

String

Yes

openbanking_customer_id

Existing Open Banking customer identifier (optional). If not provided, a new one is generated.

If the customer is already registered with Open Banking, use the previously supplied customer Id in order to have all the connected accounts linked against the same customer in Open Banking.

String

No

customer_id

External identifier of customer (account holder) used when interacting with Thredd.

String

No

experience

The unique experience GUID to set Connect URL styling options (For example, logo and colours).

Depending on the Open Banking service selected (for example, Instant Account Verification (US)), experience updates the Register URL. For example, if the user can select one or multiple financial accounts, type of accounts that can be selected.

If the experience ID is not supplied, a non-service specific default experience is used, which may, at times, be inconvenient for the subsequent data retrieval requests (Such as having to select one of the many accounts). For this reason, while this is a non-mandatory field, it is advisable to use experience IDs if/when they are supplied by your Thredd Implementations manager.

String

No