Finicity Connect OAuth Options

Overview

Connect supports the ability to override default OAuth options per url by passing the `oauthOptions` object in the generate call (https://api.finicity.com/connect/v1/generate). Only JSON is supported when using the `oauthOptions` object.

Example 1 Body Connect (aggregation):

In this example it will disable OAuth institutions for that particular Connect URL. Setting the value to ‘true’ will enable OAuth institutions like CCC.

{
    "partnerId": "{{PARTNER_ID}}",
    "customerId": "{{CUSTOMER_ID}}",
    "type": "aggregation",
    "oauthOptions": {
    "enabled": false
    }
}

Example 2 Body Connect (aggregation):

There’s also the option of replacing legacy institutions with their OAuth version.  By doing this Connect will replace Chase (InstitutionId: 5) with CCC (institutionId: 102224) when a user clicks on Chase.

{
    "partnerId": "{{PARTNER_ID}}",
    "customerId": "{{CUSTOMER_ID}}",
    "type": "aggregation",
    "oauthOptions": {
    "enabled": true,
    "institutions": {
    "5": true
    }
    }
}

Example 1 Body Connect (Credit Decisioning):

{
    "partnerId": "{{PARTNER_ID}}",
    "customerId": "{{CUSTOMER_ID}}",
    "consumerId": "{{CONSUMER_ID}}",
    "type": "voa",
    "oauthOptions": {
    "enabled": false
    }
}

The previous will disable oauth institutions for that particular URL. Setting the value to true will enable oauth institutions like CCC.

Example 2 Body Connect (Credit Decisioning):

{
    "partnerId": "{{PARTNER_ID}}",
    "customerId": "{{CUSTOMER_ID}}",
    "consumerId": "{{CONSUMER_ID}}",
    "type": "voa",
    "oauthOptions": {
    "enabled": true,
    "institutions": {
    "5": true
    }
    }
}

 By doing this Connect will replace Chase (InstitutionId: 5) with CCC (institutionId: 102224) when a user clicks on Chase.

Example Body Connect Lite:

You can also do the same with Connect Lite as shown below.

{
    "partnerId": "{{PARTNER_ID}}",
    "customerId": "{{CUSTOMER_ID}}",
    "type": "lite",
    "institutionId": "5",
        "oauthOptions": {
    "enabled": true,
    "institutions": {
    "5": true
    }
    }
}

Example Body Connect Lite with OAuth InstitutionId:

Alternatively, you can use the OAuth institutionId as shown below to directly load the OAuth Institution. Your API account does need to be OAuth enabled by your system engineer or customer support representative.

{
    "partnerId": "{{PARTNER_ID}}",
    "customerId": "{{CUSTOMER_ID}}",
    "type": "lite",
    "institutionId": "102224"
}