Get Institution List

This API will help to get a list of available institutions in Brick.

Request Parameters

Key ParametersData typeDescription
public_access_tokenStringUnique Identifier token for clients, Also called as public_access_token

Response Parameters

Key ParametersData TypeDescription
statusIntResponse code status
data-messageStringMessage to inform the user
data-countIntInstitution counter
data-institution_listArrayInstitution list
data-institution_list-idIntPrimary key for institution
data-institution_list-nameStringName of the institution
data-institution_list-institution_codeStringCode of the institution
data-institution_list-country_codeStringCountry code for the institution
data-institution_list-country_nameStringCountry name for the institutions
data-institution_list-primary_colorStringPrimary colour used by institution
data-institution_list-created_atStringTime when institutions were integrated with Brick
data-institution_list-updated_atStringTime when functionality of the institutions was updated
data-institution_list-channelsStringInstitution type (e.g. Internet Portal or Mobile App)
data-institution_list-is_ocr_activeBoolOCR availability for the institution
data-institution_list-automatic_verificationBoolAutomatic verification is available or not
data-institution_list-pdf_verificationBoolPDF verification is available or not
data-institution_list-passbook_verificationBoolPassbook verification is available or not
data-institution_list-institution_typeStringType of Institutions
Language
Click Try It! to start a request and see the response here!