Countries

List account-verification corridors

get/client/corridors

The per-country rules an account verification must satisfy: which fields are required, what format they take, and whether the corridor returns the account holder name or only confirms one you supply. Use this to build a request that will pass validation rather than discovering the rules from a 422.

Authorization

API key in the X-API-Key header.

Request

curl -X GET 'https://api.uselira.com/api/v1/client/corridors' \
  -H 'X-API-Key: YOUR_API_KEY'

const response = await fetch('https://api.uselira.com/api/v1/client/corridors', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://api.uselira.com/api/v1/client/corridors",
    headers={"X-API-Key": "YOUR_API_KEY"},
)

data = response.json()

Response

[
  {
    "country": "GB",
    "nameHandling": "match",
    "accountNameRequired": true,
    "accountNumber": {
      "required": true,
      "format": "For GB, `bankCode` must be the 6-digit sort code."
    },
    "bankCode": {
      "required": true,
      "format": "For GB, `bankCode` must be the 6-digit sort code."
    },
    "accountHolderTypeRequired": false,
    "supportedAccountHolderTypes": [
      "INDIVIDUAL",
      "BUSINESS"
    ],
    "requiredIdentifiers": [
      "BUSINESS_REGISTRATION"
    ]
  }
]