> ## Documentation Index > Fetch the complete documentation index at: https://docs.onswitch.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get institution > Retrieve institution-related data for the authenticated service. When `country` is provided, returns institutions (e.g. banks). ## OpenAPI ````yaml /openapi.json get /institution openapi: 3.0.3 info: title: Receive stablecoin. Get fiat in seconds. description: Stablecoin collection and settlement layer. version: 1.0.0 contact: name: Switch Labs email: contact@onswitch.xyz license: name: Proprietary x-tagGroups: - name: Institution tags: - Institution - name: Miscellaneous tags: - Miscellaneous - name: History tags: - History - name: Payment tags: - Payment - name: Webhook tags: - Webhook - name: Offramp tags: - Offramp - name: Onramp tags: - Onramp - name: Swap tags: - Swap - name: Developer tags: - Developer - name: Wallet tags: - Wallet - name: Compliance tags: - Compliance servers: - url: https://api.onswitch.xyz description: Production server security: [] tags: - name: Institution description: Institution discovery and bank or payment-rail lookup - name: Miscellaneous description: Requirements, coverage, assets, confirmation, and transaction status - name: History description: Payment history and summaries for the partner's account - name: Payment description: Saved payment beneficiaries, payment confirmation, and status - name: Webhook description: Webhook delivery history and callback resend - name: Offramp description: Offramp transaction endpoints for converting stablecoins to local currency - name: Onramp description: Onramp transaction endpoints for converting local currency to stablecoins - name: Swap description: Swap endpoints for exchanging between different stablecoin assets - name: Developer description: Developer fee balance and withdrawal - name: Wallet description: >- Wallet endpoints for creating and managing chain abstracted stablecoin wallets - name: Compliance description: AML compliance screening for PEP, sanctions, and other regulatory reasons paths: /institution: get: tags: - Institution summary: Get institution description: >- Retrieve institution-related data for the authenticated service. When `country` is provided, returns institutions (e.g. banks). operationId: getInstitution parameters: - name: country in: query required: false description: Country code (optional). schema: $ref: '#/components/schemas/CountryCode' example: NG - name: currency in: query required: false description: Currency code (optional). schema: $ref: '#/components/schemas/CurrencyCode' example: NGN - name: channel in: query required: false description: Transfer channel (optional filter). schema: $ref: '#/components/schemas/TransferChannel' responses: '200': description: Successfully retrieved institution data content: application/json: schema: type: object required: - success - message - timestamp - data properties: success: type: boolean message: type: string timestamp: type: string format: date-time data: description: >- Institution list or configuration payload (shape varies by query parameters) type: array nullable: true items: type: object required: - code - name - country properties: code: type: string name: type: string country: $ref: '#/components/schemas/CountryCode' example: success: true message: Retrieved 2 institutions for NG timestamp: '2026-04-18T14:22:08.631Z' data: - code: '058' name: Guaranty Trust Bank Plc country: NG - code: '033' name: United Bank for Africa country: NG '400': $ref: '#/components/responses/BadRequest' security: - ServiceKey: [] components: schemas: CountryCode: type: string enum: - AD - AE - AF - AG - AI - AL - AM - EU - AN - AO - AQ - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - GZ - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW CurrencyCode: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - FOK - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KID - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TVD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XDR - XOF - XPF - YER - ZAR - ZMW - ZWL TransferChannel: type: string enum: - BANK - BLOCKCHAIN - SWIFT - SEPA - SEPA_EUR - WIRE - ACH - DOMESTIC_GBP - MOBILEMONEY - ALIPAY - WECHATPAY responses: BadRequest: description: Bad request - Invalid input parameters or validation error content: application/json: schema: type: object required: - success - message - timestamp properties: success: type: boolean example: false message: type: string description: Error message describing what went wrong timestamp: type: string format: date-time data: description: Additional error details nullable: true example: success: false message: amount must be greater than 0 for the selected corridor timestamp: '2026-04-18T14:22:08.631Z' data: null securitySchemes: ServiceKey: type: apiKey in: header name: x-service-key description: Service key for API authentication ````