Get Institution List

2min

Get the list of participants(Open finance and open data) for the end user in the Link's context
GET
Request
Header Parameters
Authorization
required
String
Bearer link token, it returned by the /links
Curl
curl --location 'https://api-sandbox.klavi.ai/data/v1/links/institutions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location 'https://api-sandbox.klavi.ai/data/v1/links/institutions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
[
    {
        "institutionCode":"341",
        "name":"Itau",
        "avatar":"https://avatarcredigo.s3.sa-east-1.amazonaws.com/banklogo/4d9277e5-6d8b-11ee-8c78-0a8b9f03afaa_of_itau.svg",
        "isBeta": false,
        "isOutage":false,
        "institutionType":1,
        "businessType":"LEGAL",
        "availableResources":[
            "REGISTRATION",
            "ACCOUNTS"
        ]
    },
    {
        "institutionCode":"260",
        "name":"Nubank",
        "avatar":"https://avatarcredigo.s3.sa-east-1.amazonaws.com/banklogo/4d9277e5-6d8b-11ee-8c78-0a8b9f03afaa_of_nubank.svg",
        "isBeta": false,
        "isOutage":false,
        "institutionType":1,
        "businessType":"LEGAL",
        "availableResources":[
            "REGISTRATION",
            "ACCOUNTS"
        ]
    }
]
[
    {
        "institutionCode":"341",
        "name":"Itau",
        "avatar":"https://avatarcredigo.s3.sa-east-1.amazonaws.com/banklogo/4d9277e5-6d8b-11ee-8c78-0a8b9f03afaa_of_itau.svg",
        "isBeta": false,
        "isOutage":false,
        "institutionType":1,
        "businessType":"LEGAL",
        "availableResources":[
            "REGISTRATION",
            "ACCOUNTS"
        ]
    },
    {
        "institutionCode":"260",
        "name":"Nubank",
        "avatar":"https://avatarcredigo.s3.sa-east-1.amazonaws.com/banklogo/4d9277e5-6d8b-11ee-8c78-0a8b9f03afaa_of_nubank.svg",
        "isBeta": false,
        "isOutage":false,
        "institutionType":1,
        "businessType":"LEGAL",
        "availableResources":[
            "REGISTRATION",
            "ACCOUNTS"
        ]
    }
]
﻿
Response
Name
Type
Required
Description
institutionCode
String
Yes
Institution identifier
name
String
Yes
Institution show name
avatar
String
Yes
Institution logo
isBeta
Boolean
Yes
Beta status, for institutionType is 2(Open data) only
isOutage
Boolean
Yes
This flag indicates if there is any instability in the participant
true: outage
false: normal
institutionType
Number
Yes
Institution type(1: Open finance 2: Open data  )
businessType
String
Yes(Only when institutionType is 1)
The business type the participant accept, it is a NATURAL person only, LEGAL person only or BOTH
BOTH - PJ & PF
NATURAL - PF
LEGAL - PJ
availableResources
List
Yes(Only when institutionType is 1)
REGISTRATION,
ACCOUNTS,
CREDIT_CARDS,
CREDIT_OPERATIONS:LOANS,
CREDIT_OPERATIONS:FINANCINGS,
CREDIT_OPERATIONS:UNARRANGED_ACCOUNTS_OVERDRAFT,
CREDIT_OPERATIONS:INVOICE_FINANCINGS,
INVESTMENTS:BANK_FIXED_INCOMES,
INVESTMENTS:CREDIT_FIXED_INCOMES,
INVESTMENTS:VARIABLE_INCOMES,
INVESTMENTS:TREASURE_TITLES,
INVESTMENTS:FUNDS
﻿

Name	Type	Required	Description
institutionCode	String	Yes	Institution identifier
name	String	Yes	Institution show name
avatar	String	Yes	Institution logo
isBeta	Boolean	Yes	Beta status, for institutionType is 2(Open data) only
isOutage	Boolean	Yes	This flag indicates if there is any instability in the participant true: outage false: normal
institutionType	Number	Yes	Institution type(1: Open finance 2: Open data )
businessType	String	Yes(Only when institutionType is 1)	The business type the participant accept, it is a NATURAL person only, LEGAL person only or BOTH BOTH - PJ & PF NATURAL - PF LEGAL - PJ
availableResources	List	Yes(Only when institutionType is 1)	REGISTRATION, ACCOUNTS, CREDIT_CARDS, CREDIT_OPERATIONS:LOANS, CREDIT_OPERATIONS:FINANCINGS, CREDIT_OPERATIONS:UNARRANGED_ACCOUNTS_OVERDRAFT, CREDIT_OPERATIONS:INVOICE_FINANCINGS, INVESTMENTS:BANK_FIXED_INCOMES, INVESTMENTS:CREDIT_FIXED_INCOMES, INVESTMENTS:VARIABLE_INCOMES, INVESTMENTS:TREASURE_TITLES, INVESTMENTS:FUNDS

Updated 29 Sep 2024

Did this page help you?

Create a Link

Select Institution