Connect Lite 2.0 Best Practices

When using Connect Lite 2.0, we recommend using these best practices:

  • Search for a financial institution (FI)

  • Identify supported Finicity products at certified FIs

  • Generate a Connect Lite URL

Search for a Financial Institution (FI)

Given a search term by the user, search for matching institutions using the Get Institutions endpoint.

Sample
 curl -L -X GET
'https://api.finicity.com/institution/v2/institutions?search=finbank'
\
-H 'Accept: application/json' \
-H 'Finicity-App-Key: {{APP_KEY}}' \
-H 'Finicity-App-Token: {{PARTNER_SECRET}}' \

Note: We recommend displaying only one page of search results to encourage the users to make better word choice for searches. This eliminates the user scrolling through a long list of results.

Select a Financial Institution

Fincity products that are supported at a certified FI will return true.

Example:
“voa”: true,
“voi”: true,
“stateAgg”: false

Since FI certifications are frequently updated, we recommend using this real time data instead of caching.

Sample
 { 
"id": 101732,
"name": "FinBank",
"voa": true,
"voi": true,
"stateAgg": false,
"ach": true,
"transAgg": true,
"aha": false,
"accountTypeDescription": "TestFI",
"phone": "", "urlHomeApp":
"https://finbank.prod.fini.city/CCBankImageMFA/login.jsp",
"urlLogonApp":
"https://finbank.prod.fini.city/CCBankImageMFA/login.jsp",
"oauthEnabled": false,
"urlForgotPassword":
"https://developer.finicity.com/admin/account/password/new",
"urlOnlineRegistration":
"https://www.finicity.com/signup/",
"class": "testfi",
"specialText": "Please enter your FinBank Username and Password required for login.",
"specialInstructions": null,
"address": {
"city": "Utah",
"state": "",
"country": "USA",

"postalCode": "",
"addressLine1": "",
"addressLine2": ""
},
"currency": "USD",
"email": "finbank.ds5@finicity.com",
"status": "online",
"newInstitutionId": null,
"branding": {
"logo": "https://prod-carpintero-branding.s3.us-west2.amazonaws.com/101732/logo.svg",
"alternateLogo": "https://prod-carpinterobranding.s3.us-west-2.amazonaws.com/101732/alternateLogo.svg",
"icon": "https://prod-carpintero-branding.s3.us-west2.amazonaws.com/101732/icon.svg",
"primaryColor": "#1B3E4A",
"tile": "https://prod-carpintero-branding.s3.us-west-
2.amazonaws.com/101732/tile.svg"
},
"oauthInstitutionId": null
}

Generate a Connect Lite URL

Use the FI’s id, institutionID, to generate a Connect Lite URL.

Sample
 curl -L -X POST 'https://api.finicity.com/connect/v2/generate/lite'
\
-H 'Accept: application/json' \
-H 'Finicity-App-Key: {{APP_KEY}}' \
-H 'Finicity-App-Token: {{PARTNER_SECRET}}' \
-H 'Content-Type: application/json' \
--data-raw '{
"partnerId": "{{PARTNER_ID}}",
"customerId": "{{CUSTOMER_ID}}",
"institutionId": {{INSTITUTION_ID}},
"webhook": "{{WEBHOOK_URL}} }'