Get Institution by ID

introduction the "get institution by id" api facilitates the retrieval of financial institution details by using institution id by utilizing this service, you can access a comprehensive range of data objects pertaining to the bank these data objects include information like bank name, addresss of bank, email of bank, phone number of bank etc it is important to note that the specific data returned by the api may vary depending on the financial institution, as not all institutions provide the same set of data supported regions us api details this api require only 1 input institutionid the unique identifier for the bank sample curl curl location request post 'https //api signzy app/api/v3/bank connect/bank details' \\ \ header 'authorization \<token>' \\ \ header 'content type application/json' \\ \ data raw '{ "institutionid" "4222", }'curl location request post 'https //api preproduction signzy app/api/v3/bank connect/bank details' \\ \ header 'authorization \<token>' \\ \ header 'content type application/json' \\ \ data raw '{ "institutionid" "4222", }' request body parameters parameter name data type required description institutionid integer yes the id of a financial institution, represented as a number sample response { "institution" { "id" 4222, "name" "finbank", "transagg" true, "ach" true, "stateagg" false, "voi" true, "voa" true, "aha" false, "availbalance" false, "accountowner" true, "studentloandata" true, "loanpaymentdetails" true, "accounttypedescription" "workplace retirement", "phone" "1 801 984 4200", "urlhomeapp" "https //www example com/home", "urllogonapp" "https //www example com/login", "oauthenabled" true, "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 ", "timezone" "america/denver", "specialinstructions" \[ "account details", "balances and transactions", "personal and account ownership info" ], "specialinstutionstitle" "special oauth login instructions", "address" { "city" "murray", "state" "ut", "country" "usa", "postalcode" "84123", "addressline1" "434 w ascension way", "addressline2" "suite #200" }, "currency" "usd", "email" "myname\@mycompany com", "status" "online", "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 } } response body parameters \<! td {border 1px solid #cccccc;}br {mso data placement\ same cell;} > parameter name data type description institution institution an instance of the institution object id integer the id of the financial institution represented as a number name string the name of the institution example "finbank" transagg boolean indicates if the institution is certified for the transaction aggregation product ach boolean indicates if the institution is certified for the ach product stateagg boolean indicates if the institution is certified for the statement aggregation product voi boolean indicates if the institution is certified for the voi (verification of income) product voa boolean indicates if the institution is certified for the voa (verification of assets) product aha boolean indicates if the institution is certified for the account history aggregation product availbalance boolean indicates if the institution is certified for the account balance check (abc) product accountowner boolean indicates if the institution is certified for the account owner product studentloandata boolean indicates if the institution is certified for the student loan data product loanpaymentdetails boolean indicates if the institution is certified for the loan payment detail product accounttypedescription string description of the account types supported by the institution possible values banking, investments, credit cards/accounts, workplace retirement, mortgages and loans, insurance example "workplace retirement" phone string the phone number of the institution maximum length 15 example "1 801 984 4200" urlhomeapp string the url of the institution's primary home page urllogonapp string the url of the institution's login page oauthenabled boolean indicates if the institution is an oauth connection urlforgotpassword string institution's forgot password page urlonlineregistration string institution's signup page class string the class of the institution example "retirement" specialtext string special instructions given to customers for login example "please enter your principal financial retirement (personal) username and password " timezone string the time zone of the institution example "america/denver" specialinstructions array\[string] instructions given to the customer before they are sent to the institution website to login for oauth institutions example \["account details", "balances and transactions", "personal and account ownership info"] specialinstructionstitle string the title of the special instructions, if one exists or is required example "special oauth login instructions" address institutionaddress an instance of the institutionaddress object representing the address of the financial institution address city string city of the institution's address example "murray" address state string state of the institution's address example "ut" address country string country code of the institution's address in iso 3166 1 alpha 2 or alpha 3 format example "usa" address postalcode string zip code of the institution's address example "84123" address addressline1 string address line 1 of the institution's address example "434 w ascension way" address addressline2 string address line 2 of the institution's address example "suite #200" currency string the currency code used by the institution example "usd" email string an email address status string the status of the institution "online", "offline", "maintenance", "testing" newinstitutionid integer the new id of the financial institution represented as a number branding branding an instance of the branding object representing the branding assets of the institution branding logo string file path of the institution's logo https //prod carpintero branding s3 us west 2 amazonaws com/5/logo svg " branding alternatelogo string file path of the institution's alternate logo https //prod carpintero branding s3 us west 2 amazonaws com/5/alternatelogo svg " branding icon string file path of the institution's icon example " https //prod carpintero branding s3 us west 2 amazonaws com/5/icon svg " branding primarycolor string hex code for the institution's primary color example "#0167ae" branding tile string file path of the institution's name logo https //prod carpintero branding s3 us west 2 amazonaws com/5/tile svg " oauthinstitutionid integer the id of the financial institution for oauth connections represented as a number sample error { "error" { "name" "error", "message" "invalid date", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 200 } } error response parameters parameter description error this parameter contains the error error name the name of the error error message the error message error status status of the api error reason reason for error error type type of the error error statuscode request status code from signzy getting help please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better you can reach out to us at we strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively we value your feedback and are committed to making your experience smooth and enjoyable our team is dedicated to assisting you with any needs you may have thank you for choosing our services we look forward to helping you!