Skip to content
HALOWERK

Formatwerk

creditor id validate

Normalises each identifier (blanks removed, upper case) and checks: SEPA country (ibantools list), check digits computed like the IBAN check digits but without positions 5-7 (creditor business code): national part with non-alphanumeric characters removed, plus country code and "00", letters A=10..Z=35, 98 minus the remainder modulo 97; business code alphanumeric; total length 8-35. German identifiers must be exactly 18 characters with an 11-digit national identifier, position 8 is "0" until.

POST https://format.halowerk.com/v1/creditor-id-validate

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
creditor_idsarrayNoCreditor identifiers to validate.
composeobjectNoCompute the check digits for a new identifier.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "creditor_ids": {
      "type": "array",
      "minItems": 1,
      "maxItems": 1000,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 60
      },
      "description": "Creditor identifiers to validate."
    },
    "compose": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "country",
        "national_identifier"
      ],
      "description": "Compute the check digits for a new identifier.",
      "properties": {
        "country": {
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "ISO country code."
        },
        "business_code": {
          "type": "string",
          "pattern": "^[A-Z0-9]{3}$",
          "default": "ZZZ",
          "description": "Creditor business code, default ZZZ."
        },
        "national_identifier": {
          "type": "string",
          "minLength": 1,
          "maxLength": 28,
          "description": "Country-specific part (DE: 11 digits)."
        }
      }
    }
  }
}

Open original schema

Published input example

{
  "creditor_ids": [
    "DE98ZZZ09999999999",
    "DE54ZZZ09999999999"
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’