Okra API endpoints for Bank

Get list of banks

get /banks/list

This endpoint allows you retrieve the list of all institutions currently supported by Okra.

HTTP bearer bearer

Response

ExamplesSchema

OK

{
  "status": "success",
  "message": "Banks successfully retrieved",
  "data": {
    "banks": [
      {
        "id": "5d6fe57a4099cc4b210bbeb1",
        "name": "First Bank of Nigeria",
        "slug": "first-bank-of-nigeria",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/First+Bank+Nigeria+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "transactions",
          "identity",
          "direct-debit ",
          "periodic-transactions",
          "periodic-balance"
        ],
        "colors": {
          "primary": "#162D4C",
          "accent": "#DFAC0F",
          "bg": "#295590",
          "button": "#162D4C",
          "icon": "#162D4C"
        },
        "secret_question_or_otp": true,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": true,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": true,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:10:43.968Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeae",
        "name": "Ecobank Nigeria",
        "slug": "ecobank-nigeria",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Ecobank+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "transactions",
          "identity"
        ],
        "colors": {
          "primary": "#00577A",
          "accent": "#BED602",
          "bg": "#007CB3",
          "button": "#0082BB",
          "icon": "#00577A"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T20:19:33.057Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb0",
        "name": "Fidelity Bank",
        "slug": "fidelity-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Fidelity+Bank+Nigeria+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "transactions",
          "identity"
        ],
        "colors": {
          "accent": "#4DC247",
          "primary": "#010C42",
          "button": "#11237D"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": true,
            "save_bene": true
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T20:21:23.193Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb2",
        "name": "First City Monument Bank",
        "slug": "first-city-monument-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/First+City+Monument+Bank+Ltd+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#5C2682",
          "accent": "#5C2682",
          "bg": "#8737BC",
          "button": "#5C2682",
          "icon": "#5C2682"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false,
          "web": {
            "recurring": true
          }
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:01:09.202Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb3",
        "name": "Guaranty Trust Bank",
        "slug": "guaranty-trust-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Guaranty+Trust+Bank+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "transactions",
          "balance",
          "identity"
        ],
        "colors": {
          "primary": "#D94F00",
          "accent": "#DD4F05",
          "button": "#DD4F05",
          "icon": "#D94F00"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": true,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": true
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": true
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2020-09-05T23:39:26.124Z",
        "last_updated": "2021-08-16T21:10:33.494Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb4",
        "name": "Heritage Bank",
        "slug": "heritage-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Heritage+Bank+PLC+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "accent": "#4EC243",
          "primary": "#68AC48",
          "button": "#22991E",
          "icon": "#68AC48"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T17:27:00.946Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb6",
        "name": "Stanbic IBTC Bank",
        "slug": "stanbic-ibtc-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Stanbic+IBTC+Bank+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#00529B",
          "accent": "#295590",
          "bg": "#01529B",
          "button": "#01529B"
        },
        "secret_question_or_otp": true,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": true,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": true,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG",
          "KY"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T11:55:07.450Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb8",
        "name": "Sterling Bank",
        "slug": "sterling-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Sterling+Bank+Plc+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "identity",
          "transactions"
        ],
        "colors": {
          "primary": "#DB353A",
          "accent": "#D92128",
          "button": "#D92128"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-15T23:25:29.122Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb9",
        "name": "Union Bank of Nigeria",
        "slug": "union-bank-of-nigeria",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Union+Bank+Nigeria+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "transactions",
          "identity",
          "balance"
        ],
        "colors": {
          "primary": "#03B1F0",
          "accent": "#008CC2",
          "button": "#03B1F0",
          "icon": "#03B1F0"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:12:22.560Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb5",
        "name": "Polaris Bank",
        "slug": "polaris-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Polaris+Bank+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#8934AD",
          "accent": "#FBB600",
          "bg": "#8934AD",
          "button": "#56286A",
          "icon": "#8934AD"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:03:44.367Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeb7",
        "name": "Standard Chartered Bank",
        "slug": "standard-chartered-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Standard+Chartered+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#004A6E",
          "accent": "#0072A9",
          "bg": "#2C3844",
          "button": "#008737"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG",
          "KY"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:06:57.981Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbeba",
        "name": "Keystone Bank",
        "slug": "keystone-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Keystone+Bank+Limited+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "transactions",
          "balance"
        ],
        "colors": {
          "primary": "#133F77",
          "accent": "#123F76",
          "bg": "#133F77",
          "button": "#123F76"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T20:01:47.389Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbebb",
        "name": "United Bank For Africa",
        "slug": "united-bank-for-africa",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/United+Bank+for+Africa+Logo%402x.png",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#03B1F0",
          "accent": "#F0443C",
          "bg": "#D6231C",
          "button": "#F0443C",
          "icon": "#D6231C"
        },
        "secret_question_or_otp": true,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": false,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:12:16.476Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbebe",
        "name": "Alat",
        "slug": "alat",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/ALAT+by+Wema+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#C7001D",
          "accent": "#C7001D",
          "button": "#C7001D",
          "icon": "#C7001D"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-13T21:18:56.898Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbebf",
        "name": "Providus Bank",
        "slug": "providus-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Providus+Bank+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "transactions",
          "identity"
        ],
        "colors": {
          "primary": "#FBB715",
          "accent": "#FBB715",
          "icon": "#30444D",
          "button": "#2F434E",
          "bg": "#2F434E"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": true,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-14T12:18:27.354Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbebc",
        "name": "Wema Bank",
        "slug": "wema-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Wema+Bank+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "transactions",
          "identity"
        ],
        "colors": {
          "primary": "#990D81",
          "accent": "#990D81",
          "bg": "#990D81",
          "button": "#880972"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": true,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": true,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false,
          "web": {
            "recurring": true
          }
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:05:13.439Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbebd",
        "name": "Unity Bank",
        "slug": "unity-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Unity+Bank+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#253D51",
          "accent": "#7AB702",
          "bg": "#2E465A",
          "button": "#7AB702"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-10T22:39:57.204Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbec2",
        "name": "Zenith Bank",
        "slug": "zenith-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Zenith+Bank+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "identity",
          "transactions"
        ],
        "colors": {
          "button": "#E3000F",
          "accent": "#E3000F",
          "primary": "#808285"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": true,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": false,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:03:45.374Z"
      },
      {
        "id": "5d6fe57a4099cc4b210bbec0",
        "name": "Access Bank",
        "slug": "access-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Access+Bank+PLC+Logo+Color.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "transactions",
          "balance",
          "identity"
        ],
        "colors": {
          "primary": "#114185",
          "accent": "#114185",
          "button": "#F0632B"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": true
          },
          "corp": {
            "exists": true,
            "recurring": false,
            "save_bene": true
          },
          "mobile": {
            "exists": true,
            "sso": true,
            "recurring": true,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": true,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2019-09-04T10:04:29.000Z",
        "last_updated": "2021-08-16T21:10:23.928Z"
      },
      {
        "id": "5f0cf73e8a8bcc18b8156ad7",
        "name": "Kuda Bank",
        "slug": "kuda-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Kuda+icon.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#401a6e",
          "bg": "#41276D",
          "button": "#41276D",
          "accent": "#00D883",
          "icon": "#41276D"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2020-07-14T00:07:26.550Z",
        "last_updated": "2021-08-16T19:39:54.404Z"
      },
      {
        "id": "5f11487e847b28538bfc6c5f",
        "name": "Rubies Bank",
        "slug": "rubies-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Rubies+Bank+Icon.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "primary": "#CA0302",
          "button": "#CA0302",
          "accent": "#CA0302"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": false,
        "status": "healthy",
        "individual": true,
        "created_at": "2020-07-17T06:43:10.730Z",
        "last_updated": "2021-08-10T22:39:57.966Z"
      },
      {
        "id": "5f63f473d550180010a14bf1",
        "name": "Diamond Bank",
        "slug": "diamond-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Diamond+Bank+Icon.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions"
        ],
        "colors": {
          "accent": "#BAD306",
          "bg": "",
          "button": "#3C4548",
          "primary": "#3C4548"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2020-09-21T02:36:29.536Z",
        "last_updated": "2021-08-10T22:39:57.056Z"
      },
      {
        "id": "5fad03e18a795405d628156f",
        "name": "V Bank",
        "slug": "v-bank",
        "icon": "",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "balance",
          "identity",
          "transactions"
        ],
        "colors": {
          "primary": "#F0463D",
          "accent": "#F0463D",
          "button": "#9B2166"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": true,
            "sso": true,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "status": "healthy",
        "individual": true,
        "created_at": "2020-11-12T09:44:01.781Z",
        "last_updated": "2020-11-26T08:44:58.190Z"
      },
      {
        "id": "5fb906f78c486a00b987ec06",
        "name": "Jaiz Bank",
        "slug": "jaiz-bank",
        "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Jaiz+Bank+Icon.svg",
        "v2_icon": "",
        "v2_logo": "",
        "products": [
          "auth",
          "identity",
          "balance",
          "transactions",
          "payment"
        ],
        "colors": {
          "accent": "#C4A207",
          "button": "#1F512B"
        },
        "secret_question_or_otp": false,
        "secret_question_or_otp_mobile": false,
        "secret_question_or_otp_corp": false,
        "payments": {
          "ind": {
            "exists": true,
            "recurring": false,
            "save_bene": false
          },
          "corp": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "mobile": {
            "exists": false,
            "sso": false,
            "recurring": false,
            "save_bene": false
          },
          "ussd": {
            "exists": false,
            "recurring": false,
            "save_bene": false
          },
          "secret": false
        },
        "ussd": false,
        "countries": [
          "NG"
        ],
        "corporate": true,
        "status": "healthy",
        "individual": true,
        "created_at": "2020-11-21T13:21:00.000Z",
        "last_updated": "2021-08-10T22:39:57.491Z"
      }
    ]
  }
}

Get bank by id

get /banks/getById

Get the details of a specific institution.

id

string

required

The unique ID of a bank. Visit Okra's Coverage page for the list of bank IDs.

Response

ExamplesSchema

OK

{
  "status": "success",
  "message": "Bank successfully retrieved",
  "data": {
    "colors": {
      "primary": "",
      "accent": "",
      "bg": "",
      "button": "",
      "icon": ""
    },
    "keyboards": {
      "web_username_placeholder": "",
      "web_password_placeholder": "",
      "mobile_username_placeholder": "",
      "mobile_password_placeholder": "",
      "web_corp_username_placeholder": "",
      "web_corp_password_placeholder": "",
      "mobile_corp_username_placeholder": "",
      "mobile_corp_password_placeholder": "",
      "token_corp_placeholder": "",
      "token_ind_placeholder": "",
      "username": "",
      "password": ""
    },
    "payments": {
      "ind": {
        "exists": true,
        "recurring": false,
        "save_bene": false
      },
      "corp": {
        "exists": false,
        "recurring": false,
        "save_bene": false
      },
      "mobile": {
        "exists": false,
        "sso": false,
        "recurring": false,
        "save_bene": false
      },
      "ussd": {
        "exists": false,
        "recurring": false,
        "save_bene": false
      }
    },
    "countries": [
      "NG"
    ],
    "sso": true,
    "dual": false,
    "sso_corp": true,
    "products": [
      "auth",
      "balance",
      "transactions",
      "identity"
    ],
    "keywords": [],
    "uuid": false,
    "hasWeb": false,
    "only_token": false,
    "only_mobile": false,
    "ussd": true,
    "square_logo": false,
    "secret_question_or_otp": false,
    "multi_login": [],
    "_id": "",
    "__v": 0,
    "active": true,
    "created_at": "",
    "icon": "",
    "individual": true,
    "inverted_logo": "",
    "logo": "",
    "name": "",
    "old_icon": "",
    "old_logo": "",
    "reset_link": "",
    "reset_link_corp": "",
    "slug": "",
    "sortcode": 50150010,
    "status": "",
    "token_ind": false,
    "v2_icon": "",
    "v2_logo": "",
    "corporate": true,
    "png_logo": ""
  }
}

Was this page helpful?