Connect Fix / Send Connect Email
Use the connect fix endpoint when the following conditions occur:
The connection to the user’s financial institution is lost
The user’s credentials were updated (any number of reasons)
The user’s MFA challenge has expired
curl -L -X POST 'https://connect.finicity.com/connect/v2/generate/fix
\
-H 'Accept: application/json' \
-H 'Finicity-App-Key: {{APP_KEY}}' \
-H 'Finicity-App-Token: {{APP_TOKEN}}' \
-H 'Content-Type: application/json' \
--data-raw '{
"partnerId": "{{PARTNER_ID}}",
"customerId": "{{CUSTOMER_ID}}",
"redirectUri": "https://example.com/redirectHandler",
"webhook": "https://example.com/webhookHandler",
"institutionLoginId": 1011648032
}'
Rather than sending a Connect URL through the API, you can send an email to the consumer that includes a Connect link. The email includes a button which opens Connect.
The key differences between Connect 1.0 and 2.0.
Previously, when generating a Connect URL, the parameter type had to be specified, such as aggregation, voa, lite, fix, and more.
Now, the parameter experience is used to refer to the type of Connect experience for the session, such as the logo, brand color. application name and product, such as voa, voi, and more.
Finicity Sales Engineers will configure experience to default as part of the migration process.
curl -L -X POST 'https://connect.finicity.com/connect/v2/send/email' \
-H 'Accept: application/json' \
-H 'Finicity-App-Key: {{APP_KEY}}' \
-H 'Finicity-App-Token: {{APP_TOKEN}}' \
-H 'Content-Type: application/json' \
--data-raw '{
"partnerId": "{{PARTNER_ID}}",
"customerId": "{{CUSTOMER_ID}}",
"consumerId": "{{CONSUMER_ID}}",
"redirectUri": "https://examople.com/redirectHandler",
"experience": "default",
"email": {
"to": "bob@example.com",
"supportPhone": "800-555-5555",
"subject": "Verify your income",
"firstName": "Bob",
"institutionName": "Acme Lending",
"institutionAddress": "222 Winnipeg Drive SLC UT, 84109",
"signature": [
"Cindy Mayfield",
"Senior Loan Officer",
"Direct 123-456-7890"
]
}
}'