Register Open Banking Customer

The Register Open Banking Customer endpoint enables you to register a customer to Open Banking. This endpoint enables Thredd to create an internal customer identifier and retrieve the Open Banking registration URL from Mastercard Finicity.

The customer connects their account by being redirected through a secure link. where they need to provide their consent to data sharing and authenticate themselves for the selected financial institution. When this is complete, the customer confirms which accounts to allow Open Banking access to.

When the account is connected (and the customer is registered to Open Banking), you can use Thredd’s Open Banking APIs to get financial information such as account details from the customer’s financial institution. Note: The customer reserves the right to revoke their consent to data sharing at any time.

📘

Note

You can receive Webhook notifications that track the steps that the customer takes when they register for Open Banking. For more information, see Introduction to Webhooks.

You can register a customer for open banking by making a POST request to the endpoint. For example:

https://uat-api.thredd.com/api/v1/open-banking/register

See the below example of a request. The openbanking_customer_id field is a Thredd generated ID and is required for subsequent calls in that customer's context.

For example, for a registered customer with an openbanking_customer_id, the same ID is used in the request body for connecting new financial accounts. If the customer is not registered yet, the openbanking_customer_id is returned after the first Register Open Banking Customer request. The openbanking_customer_id should be stored against the customer for future use.

curl --request POST \
     --url https://uat-api.thredd.com/api/v1/open-banking/register \
     --header 'accept: application/json' \
     --header 'client-id: Client A' \
     --header 'partner-id: 1234567890123' \
     --header 'content-type: application/json' \
     --data '
{
  "is_hosted_in_mobile_app": true,
  "redirect_uri": "https://myapp.com/callback",
  "openbanking_customer_id": "12345",
  "customer_id": "09876",
  "experience": "fa39b699-a208-4c3d-9579-4f66e600acf8"
}

📘

Note

If a valid openbanking_customer_id is included in the request, Thredd retrieves the Mastercard Finicity Customer Identifier so that if the customer exists already only the redirect_uri is regenerated.

If successful, a 200 response is returned with the Open Banking customer identifier, and the Mastercard Finicity redirect URL.

{
  "openbanking_customer_id": "string",
  "redirect_url": "string"
}

📘

More Information

• To view this endpoint in the API Explorer, see Register Open Banking.
• To view details on the fields included in this endpoint, see Register Open Banking - Field Descriptions.