Get Institution List

1 min

institutions

Get the list of participants(Open finance and open data) for the end user in the Link's context

GET

https://api-sandbox.klavi.ai/data/v1/links/institutions

Header Parameters

Authorizationstringrequired
Description
Bearer link token, it returned by the /links

Response

institutionCodestring
Description
Institution identifier maxLength: 4
namestring
Description
Institution show name
avatarstring
Description
Institution logo
isBetaboolean
Description
Beta status
isOutageboolean
Description
This flag indicates if there is any instability in the participant true: outage false: normal
institutionTypenumber
Description
Institution type(1: Open finance 2: Open data)
businessTypestring
Description
The business type the participant accept, it is a NATURAL person only, LEGAL person only or BOTH, only when institutionType is 1 BOTH - PJ & PF NATURAL - PF LEGAL - PJ
availableResourcesarray
Description
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
organizationIdstring
Description
The identifier of the organization
organizationNamestring
Description
The name of the organization
parentOrganizationIdstring
Description
The identifier of the parent organization
parentOrganizationNamestring
Description
The name of the parent organization

curl

curl --location 'https://api-sandbox.klavi.ai/data/v1/links/institutions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

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"
        ],
        "parentOrganizationName": "",
        "parentOrganizationId": "",
        "organizationName": "ITAÚ UNIBANCO S.A.",
        "organizationId": "9c721898-9ce0-50f1-bf85-05075557850b"
    },
    {
        "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"
        ],
        "parentOrganizationName": "",
        "parentOrganizationId": "",
        "organizationName": "NU PAGAMENTOS S.A. - INSTITUIÇÃO DE PAGAMENTO",
        "organizationId": "926e3037-a685-553c-afa3-f7cb46ff8084"
    }
]