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

required

validationRequest

object

required

iban stringrequired

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

IBAN number to be validated.

Responses

200

IBAN verified successfully

application/json

Schema

Schema

validationRequest

object

required

IBAN number from the request that was validated.

iban stringrequired

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

IBAN number to be validated.

validationResult

object

required

isValidIban booleanrequired

Indicates whether the provided IBAN is valid.

validationDetails

object

Flags indicating which validation checks passed.

countryCode boolean

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

length boolean

IBAN length is correct for a specific country.

checksum boolean

Last two digits checksum matches the calculated value.

structure boolean

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

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

The IBAN number received in the request.

iban string

Possible values: <= 34 characters

The IBAN number received in the request.

countryCode string

Possible values: <= 2 characters

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

sepaCountry boolean

Indicates if country provided in IBAN participates in SEPA.

accountNumber string

Bank Account Number extracted from the IBAN.

sortCode string

Possible values: <= 8 characters

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

sepaSchemeSupport

object

Indicates if SEPA schemes available for this bank.

creditTransfer boolean

Indicates if SEPA credit transfer is supported.

directDebit boolean

Indicates if SEPA schemes available for this bank.

b2bDirectDebit boolean

Indicates if SEPA B2B direct debit is supported.

Example (from schema)

{
  "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

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Invalid IBAN format"
}

401

Unauthorized: no valid API key provided

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

403

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

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Access denied"
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

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

Example

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

Loading...