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
Production
Pre-Production
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.signzy.app/api/v3/bank-connect/bank-details' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "institutionId": "4222",
}'
﻿
Curl
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",
}'
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
JSON
{
  "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": "[email protected]",
    "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
  }
}
{
  "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. 
﻿Example: "https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/logo.svg"
branding.alternateLogo
string
File path of the institution's alternate logo. 
﻿Example: "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.
﻿ Example: "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
JSON
{
    "error": {
        "name": "error",
        "message": "Invalid Date",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 200
    }
}
{
    "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 [email protected]. 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!
﻿

Parameter name	Data type	Required	Description
InstitutionId	integer	Yes	The ID of a financial institution, represented as a number

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. Example: "https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/5/logo.svg"
branding.alternateLogo	string	File path of the institution's alternate logo. Example: "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. Example: "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.

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

Did this page help you?

Get Account Owner Details (cloned)

Get customer accounts