The institution object represents a financial institution (such as a bank, credit union etc). You can use this object to obtain a list of supported institutions or to get general information about each institution.
Attributes | |
|---|---|
| Value is "institution". |
| A string that uniquely identifies the institution. |
| The full name of the institution. |
| Short name of institution. |
| An enum identifying the institution type. Possible values include: |
| |
| Country in which this institution operates. English short name used by ISO 3166/MA. |
| Name of the supported service (as defined by the institution). |
| Institution connector: an enum identifying the service type. Possible values include: |
| |
| Institution connector: an enum identifying the authorization type. Possible values include: |
| |
| Institution connector: an enum identifying the stage. Possible values include: |
| |
| Institution connector: an enum identifying the status. Active connectors can continue to be used in every status. Possible values include: |
| |
| Institution connector: caption used by institution to request login id. |
| Institution connector: caption used by institution to request secondary login id. |
| Institution connector: caption used by institution to request password. |
| Institution connector: caption used by institution to request security code. |
| Institution connector: url to forgotten password page |
| Object that contains institution colours (e.g. primary). |
| Institution's tier - a representation of it's business and market share in the relevant country/region. Values range from 1 to 4. Tier 1 are Institutions with the highest impact on the market. For example, CBA is a Tier 1 Bank, Suncorp is a Tier 2 Bank, etc. |
| Object that contains main colors, and URLs of square and full institution logo image, returned in SVG format. |
Stats | |
|---|---|
averageDurationMs | Institution connector statistics are evaluated every 24 hours - to provide average statistics for Jobs occurring in the previous 7 days in milliseconds. Stats are provided for for each job step plus the total. |
|
Links | |
|---|---|
| A links object containing the following members: |
| |
{
"type": "list",
"totalCount": 56,
"data": [
{
"type": "institution",
"id": "AU00000",
"name": "Hooli Bank",
"shortName": "Hooli",
"institutionType": "Test Bank",
"country": "Australia",
"serviceName": "Personal Online Banking",
"serviceType": "Personal Banking",
"loginIdCaption": "Login",
"passwordCaption": "Password",
"tier": "4",
"authorization": "user-mfa-intermittent",
"features": {
"login":[
"web"
],
"mfaChallenge": [
"web"
],
"accounts": {
"accountNo": [
"web"
],
"name": [
"web"
],
"currency": [
"web"
],
"balance": [
"web"
],
"availableFunds": [
"web"
],
"lastUpdated": [
"web"
],
"accountHolder": [
"web"
],
"meta": [
"web"
]
},
"transactions": {
"status": [
"web"
],
"description": [
"web"
],
"date": [
"web"
],
"amount": [
"web"
],
"balance": [
"web"
],
"class": [
"web"
]
},
"profile": {
"fullName": [
"web"
],
"firstName": [
"web"
],
"lastName": [
"web"
],
"middleName": [
],
"phoneNumbers": [
"web"
],
"emailAddresses": [
"web"
],
"physicalAddresses": [
"web"
]
}
},
"forgottenPasswordUrl": "https://hooli.com.au/forgotten...",
"stage": "beta",
"status": "under-maintenance",
"stats": {
"averageDurationMs": {
"verifyCredentials": 3600,
"retrieveAccounts": 4500,
"retrieveTransactions": 2300,
"retrieveMeta": 1200,
"total": 11600
}
},
"logo": {
"type": "image",
"colors": null,
"links": {
"square": "https://d388vpyfrt4zrj.cloudfront.net/AU00000.svg",
"full": "https://d388vpyfrt4zrj.cloudfront.net/AU00000-full.svg"
}
},
"links": {
"self": "https://au-api.basiq.io/institutions/AU00000"
}
},
{
"type": "institution",
"id": "AU01001",
"name": "National Australia Bank Limited*",
"shortName": "NAB",
"institutionType": "Bank",
"country": "Australia",
"serviceName": "NAB Connect",
"serviceType": "Personal Banking",
"loginIdCaption": "NAB ID",
"passwordCaption": "Password",
"tier": "1",
"authorization": "user",
"features": {
"login":[
"web"
],
"mfaChallenge": [],
"accounts": {
"accountNo": [
"web",
"pdf",
"csv"
],
"name": [
"web",
"pdf",
"csv"
],
"currency": [
"web",
"pdf",
"csv"
],
"balance": [
"web",
"pdf",
"csv"
],
"availableFunds": [
"web",
"pdf",
"csv"
],
"lastUpdated": [
"web",
"pdf",
"csv"
],
"accountHolder": [
"pdf",
"csv"
],
"meta": [
"web",
"pdf"
]
},
"transactions": {
"status": [
"web",
"pdf",
"csv"
],
"description": [
"web",
"pdf",
"csv"
],
"date": [
"web",
"pdf",
"csv"
],
"amount": [
"web",
"pdf",
"csv"
],
"balance": [
"web",
"pdf",
"csv"
],
"class": [
"web",
"pdf",
"csv"
]
},
"profile": {
"fullName": [
"web"
],
"firstName": [
"web"
],
"lastName": [
"web"
],
"middleName": [
],
"phoneNumbers": [
"web"
],
"emailAddresses": [
"web"
],
"physicalAddresses": [
"web",
"pdf"
]
}
},
"forgottenPasswordUrl": "https://www2.my.commbank.com.au...",
"stage": "live",
"status": "operational",
"stats": {
"averageDurationMs": {
"verifyCredentials": 3600,
"retrieveAccounts": 4500,
"retrieveTransactions": 2300,
"retrieveMeta": 1200,
"total": 11600
}
},
"logo": {
"type": "image",
"colors": null,
"links": {
"square": "https://d388vpyfrt4zrj.cloudfront.net/AU01001.svg",
"full": "https://d388vpyfrt4zrj.cloudfront.net/AU01001-full.svg"
}
},
"links": {
"self": "https://au-api.basiq.io/institutions/AU01001"
}
}
]
}