Get Institution List

1 min

{ "name" "institutions", "method" "get", "url" "https //api sandbox klavi ai/data/v1/links/institutions", "description" "get the list of participants(open finance and open data) for the end user in the link's context", "tab" "examples", "examples" { "languages" \[ { "id" "y0cyc73davmqarfmbelfn", "language" "curl", "code" "curl location 'https //api sandbox klavi ai/data/v1/links/institutions' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" } ], "selectedlanguageid" "y0cyc73davmqarfmbelfn" }, "results" { "languages" \[ { "id" "ua exge ou6icrmljffwy", "language" "200", "customlabel" "", "code" "\[\n {\n \\"institutioncode\\" \\"341\\",\n \\"name\\" \\"itau\\",\n \\"avatar\\" \\"https //avatarcredigo s3 sa east 1 amazonaws com/banklogo/4d9277e5 6d8b 11ee 8c78 0a8b9f03afaa of itau svg\\",\n \\"isbeta\\" false,\n \\"isoutage\\" false,\n \\"institutiontype\\" 1,\n \\"businesstype\\" \\"legal\\",\n \\"availableresources\\" \n \[\n \\"registration\\",\n \\"accounts\\"\n ],\n \\"parentorganizationname\\" \\"\\",\n \\"parentorganizationid\\" \\"\\",\n \\"organizationname\\" \\"itaú unibanco s a \\",\n \\"organizationid\\" \\"9c721898 9ce0 50f1 bf85 05075557850b\\"\n },\n {\n \\"institutioncode\\" \\"260\\",\n \\"name\\" \\"nubank\\",\n \\"avatar\\" \\"https //avatarcredigo s3 sa east 1 amazonaws com/banklogo/4d9277e5 6d8b 11ee 8c78 0a8b9f03afaa of nubank svg\\",\n \\"isbeta\\" false,\n \\"isoutage\\" false,\n \\"institutiontype\\" 1,\n \\"businesstype\\" \\"legal\\",\n \\"availableresources\\" \n \[\n \\"registration\\",\n \\"accounts\\"\n ],\n \\"parentorganizationname\\" \\"\\",\n \\"parentorganizationid\\" \\"\\",\n \\"organizationname\\" \\"nu pagamentos s a instituição de pagamento\\",\n \\"organizationid\\" \\"926e3037 a685 553c afa3 f7cb46ff8084\\"\n }\n]" } ], "selectedlanguageid" "ua exge ou6icrmljffwy" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer link token, it returned by the /links", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "response" \[ { "name" "institutioncode", "kind" "optional", "type" "string", "description" "institution identifier\nmaxlength 4" }, { "name" "name", "kind" "optional", "type" "string", "description" "institution show name", "children" \[] }, { "name" "avatar", "kind" "optional", "type" "string", "description" "institution logo", "children" \[] }, { "name" "isbeta", "kind" "optional", "type" "boolean", "description" "beta status", "children" \[] }, { "name" "isoutage", "kind" "optional", "type" "boolean", "description" "this flag indicates if there is any instability in the participant\ntrue outage\nfalse normal", "children" \[] }, { "name" "institutiontype", "kind" "optional", "type" "number", "description" "institution type(1 open finance 2 open data)", "children" \[] }, { "name" "businesstype", "kind" "optional", "type" "string", "description" "the business type the participant accept, it is a natural person only, legal person only or both, only when institutiontype is 1\nboth pj & pf\nnatural pf\nlegal pj", "children" \[] }, { "name" "availableresources", "kind" "optional", "type" "array", "description" "only when institutiontype is 1\nregistration,\naccounts,\ncredit cards,\ncredit operations\ loans,\ncredit operations\ financings,\ncredit operations\ unarranged accounts overdraft,\ncredit operations\ invoice financings,\ninvestments\ bank fixed incomes,\ninvestments\ credit fixed incomes,\ninvestments\ variable incomes,\ninvestments\ treasure titles,\ninvestments\ funds", "children" \[] }, { "name" "organizationid", "kind" "optional", "type" "string", "description" "the identifier of the organization", "children" \[] }, { "name" "organizationname", "kind" "optional", "type" "string", "description" "the name of the organization", "children" \[] }, { "name" "parentorganizationid", "kind" "optional", "type" "string", "description" "the identifier of the parent organization", "children" \[] }, { "name" "parentorganizationname", "kind" "optional", "type" "string", "description" "the name of the parent organization", "children" \[] } ] }