Get Institution by ID
GET {{baseUrl}}/institution/v2/institutions/{{institutionId}}
Get financial institution details by ID.
Supported regions:
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Finicity-App-Key | string | ||
Accept | string | ||
Finicity-App-Token | string |
RESPONSES
status: OK
{"institution":{"id":4222,"transAgg":true,"ach":true,"stateAgg":false,"voi":true,"voa":true,"aha":false,"availBalance":false,"accountOwner":true,"oauthEnabled":true,"currency":"USD","status":"online","name":"FinBank","accountTypeDescription":"Workplace Retirement","phone":"1-800-986-3343","urlHomeApp":"https://www.example.com/home","urlLogonApp":"https://www.example.com/login","urlForgotPassword":"https://www.example.com/forgotPassword.do","urlOnlineRegistration":"https://www.example.com/signup","class":"retirement","specialText":"Please enter your Principal Financial - Retirement (Personal) Username and Password.","specialInstructions":["Account details","Balances and transactions","Personal and account ownership info"],"address":{"city":"Murray","state":"UT","country":"USA","postalCode":"84123","addressLine1":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"addressLine2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"email":"finicity@test.com","newInstitutionId":4222,"branding":{"logo":"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/logo.svg","alternateLogo":"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/alternateLogo.svg","icon":"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/icon.svg","primaryColor":"#0167AE","tile":"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/tile.svg"},"oauthInstitutionId":4222}}