Look up a bank by clearing code or BIC

Resolves a four digit clearing code (the first four digits of an account number) or a BIC to its bank. Send only the clearing code, never the whole account number: this is a cacheable GET. To validate a full number, POST it to /v1/accounts/validate.

GET/v1/banks/lookup

Authorization

Optional — this operation also accepts unauthenticated requests.

x-api-keyAPI key · header

API key issued from the dashboard. Optional: anonymous callers are served at a lower rate limit.

AuthorizationBearer token · header

The same API key, sent as a bearer token.

Query parameters

clearingCodestring

Four digit bank identifier

matches ^\d{4}$

bicstring

ISO 9362 BIC, 8 or 11 characters

matches ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

Responses

200Default Response

bicstringrequired

ISO 9362 BIC, 8 or 11 characters

matches ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

institutionCodestringrequired

First four BIC characters

namestringrequired

countrystringrequired

clearingCodesstring[]required

logoBankLogo | anyrequired

Show properties

Any of:

BankLogo

formatsstring[]required

hashstringrequired

urlstring<uri>required

Immutable URL for the preferred format

any

any

400Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

401Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

404Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

429Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

500Default Response

typestring<uri>required

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

codestringrequired

detailstring

instancestring

errorsobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

Request

curl -X GET "http://localhost:8080/v1/banks/lookup" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch("http://localhost:8080/v1/banks/lookup", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "http://localhost:8080/v1/banks/lookup",
    headers={
        "x-api-key": "YOUR_API_KEY"
    },
)

Response

{
  "bic": "DNBANOKK",
  "institutionCode": "DNBA",
  "name": "DNB Bank ASA",
  "country": "NO",
  "clearingCodes": [
    "1503"
  ],
  "logo": {
    "formats": [
      "svg"
    ],
    "hash": "string",
    "url": "http://example.com"
  }
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "http://example.com",
  "title": "string",
  "status": -9007199254740991,
  "code": "string",
  "detail": "string",
  "instance": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}