POST api/Institution/GetInstitutionByName

Get institution by given institution name

Request Information

URI Parameters

None.

Body Parameters

Post data parameter for getting institutions by name

Name	Description	Type	Additional information
InstitutionName	Name or part of the name of the institution. E.g. "Bank of America" or "Chase". When an empty string is given all institutions will be returned.	string	None.
Extensive	When set to true, return all institutions matching the given name; when set to false, only return the top result.	boolean	None.
InstitutionType	When set to All, return any type of institutions; when set to Financial, return financial institutions only; when set to Other, return other type of institutions.	InstitutionType	None.

Request Formats

application/json, text/json

Sample:

InstitutionType indicates which type of institutions to return: E.g. "All" or 0, "Financial" or 1, "Other" or 2 
 { 
 "InstitutionName": "Bank of America",
 "Extensive": true, 
 "InstitutionType": "Financial" 
}

application/xml, text/xml

Sample:

Coming soon.

Response Information

Resource Description

Collection of Institution

Name	Type	Additional information
InstitutionID	globally unique identifier	None.
InstitutionName	string	None.
URL	string	None.
Logo	string	None.
InstitutionDetail	InstitutionDetails	None.
CountryCode	string	None.
LanguageCode	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InstitutionID": "4c2c8adc-26e1-485a-aeae-43ec112c2245",
    "InstitutionName": "sample string 2",
    "URL": "sample string 3",
    "Logo": "sample string 4",
    "InstitutionDetail": {
      "RoutingNumber": "sample string 1",
      "MultipleRoutingNumbers": "sample string 2",
      "LoginFormUserName": "sample string 3",
      "LoginFormPassword": "sample string 4",
      "LoginFormFields": null
    },
    "CountryCode": "sample string 5",
    "LanguageCode": "sample string 6"
  },
  {
    "InstitutionID": "4c2c8adc-26e1-485a-aeae-43ec112c2245",
    "InstitutionName": "sample string 2",
    "URL": "sample string 3",
    "Logo": "sample string 4",
    "InstitutionDetail": {
      "RoutingNumber": "sample string 1",
      "MultipleRoutingNumbers": "sample string 2",
      "LoginFormUserName": "sample string 3",
      "LoginFormPassword": "sample string 4",
      "LoginFormFields": null
    },
    "CountryCode": "sample string 5",
    "LanguageCode": "sample string 6"
  }
]

application/xml, text/xml

Sample:

Coming soon.