IBAN validation

POST 
/validate-iban

The IBAN validation checks an IBAN based on specific criteria including length, country code, format, checksum, structure and SEPA country recognition.

The following components of the IBAN are checked:

• Country code: verifies if the country code submitted is representing a valid country.
• Length: verifies if the IBAN length is correct for the specific country.
• Checksum: verifies that the checksum part of the IBAN is plausible towards the remainder of the IBAN.
• Structure: validates the structure of the IBAN.

In case the IBAN is valid, the following data is returned: IBAN, country code, check whether the country is part of SEPA (Single Euro Payments Area), account number, sort code and check sum.

Base URLs

	SANDBOX	PRODUCTION
API Base URL	https://ibanchecker.cons.shared.upcf.jpmmps.com/api/v1	https://ibanchecker.shared.upcf.jpmmps.com/api/v1
Merchant Key	Provided by Product Solution Specialist	Provided by Customer Relationship Manager
API Authentication Key	Provided by Product Solution Specialist	Provided by Customer Relationship Manager

The following section will describe the procedure and results of an IBAN validation. To perform the IBAN validation, provide IBAN number.

Request

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

application/json

Body

Bodyrequired

validationRequest objectrequired
ibanstringrequired
IBAN number to be validated.
Possible values: <= 34 characters, Value must match regular expression ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$
Example: DE89750500000000123456

Example

{
  "validationRequest": {
    "iban": "DE89750500000000123456"
  }
}

Responses

200

IBAN verified successfully

application/json

Schema

Schema

validationRequest objectrequired
IBAN number from the request that was validated.
ibanstringrequired
IBAN number to be validated.
Possible values: <= 34 characters, Value must match regular expression ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$
Example: DE89750500000000123456
validationResult objectrequired

isValidIbanbooleanrequired

Indicates whether the provided IBAN is valid.

Example: true

validationDetails object

Flags indicating which validation checks passed.

countryCodeboolean

Check if the value provided as country code is a valid ISO country code.

lengthboolean

IBAN length is correct for a specific country.

checksumboolean

Last two digits checksum matches the calculated value.

structureboolean

IBAN conforms to the correct formatting of its country. For certain countries, there might be additional rules governing the structure of the IBAN, such as which specific numbers/characters appear in specific positions. This field verifies that the number/letter pattern is correct.

ibanDetails object

The IBAN number received in the request.

Possible values: Value must match regular expression [A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}

ibanstring

The IBAN number received in the request.

Possible values: <= 34 characters

Example: DE89750500000000123456

countryCodestring

ISO 3166-1 country provided in IBAN participates in SEPA.

Possible values: <= 2 characters

Example: DE

sepaCountryboolean

Indicates if country provided in IBAN participates in SEPA.

Example: true

accountNumberstring

Bank Account Number extracted from the IBAN.

Example: 0000000123456

sortCodestring

Domestic bank identifier / sort code of the bank e.g., Bankleitzahl in Germany or Code Banque & Code Guiche in France.

Possible values: <= 8 characters

Example: 75050000

sepaSchemeSupport object

Indicates if SEPA schemes available for this bank.

creditTransferboolean

Indicates if SEPA credit transfer is supported.

directDebitboolean

Indicates if SEPA schemes available for this bank.

b2bDirectDebitboolean

Indicates if SEPA B2B direct debit is supported.

Example (auto)

{
  "validationRequest": {
    "iban": "DE89750500000000123456"
  },
  "validationResult": {
    "isValidIban": true,
    "validationDetails": {
      "countryCode": true,
      "length": true,
      "checksum": true,
      "structure": true
    },
    "ibanDetails": "DE89750500000000123456"
  }
}

Example

{
  "validationRequest": {
    "iban": "DE89750500000000123456"
  },
  "validationResult": {
    "isValidIban": true,
    "validationDetails": {
      "countryCode": true,
      "length": true,
      "checksum": true,
      "structure": true
    },
    "ibanDetails": {
      "iban": "DE89750500000000123456",
      "countryCode": "DE",
      "sepaCountry": true,
      "accountNumber": "0000000123456",
      "sortCode": "75050000",
      "checksum": "97"
    }
  }
}

400

Invalid input

application/json

Schema

Schema

messagestring

Example (auto)

{
  "message": "string"
}

Example

{
  "message": "Invalid IBAN format"
}

401

Unauthorized: no valid API key provided

application/json

Schema

Schema

messagestring

Example (auto)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

403

FORBIDDEN: The API key doesn't have permissions to perform the request

application/json

Schema

Schema

messagestring

Example (auto)

{
  "message": "string"
}

Example

{
  "message": "Access denied"
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}