Get Institution by ID
GET {{baseUrl}}/institution/v2/institutions/{{institutionId}}
Get financial institution details by ID.
Supported regions:
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string | ||
App-Key | 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":"AUD","status":"online","name":"FinBank","loanPaymentDetails":false,"studentLoanData":false,"accountTypeDescription":"Workplace Retirement","phone":"61-3-1234-1234","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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"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":"someone@test.com","newInstitutionId":4222,"branding":{"logo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"alternateLogo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"icon":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primaryColor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tile":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"oauthInstitutionId":4222,"timeZone":"Australia/ACT"}}