api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "bank": {
          "properties": {
            "bic": {
              "description": "ISO 9362 Business Identifier Code (BIC/SWIFT) of the account's bank",
              "type": [
                "string",
                "null"
              ]
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "bic",
            "name"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "bank_code": {
          "type": [
            "string",
            "null"
          ]
        },
        "branch_code": {
          "type": [
            "string",
            "null"
          ]
        },
        "country": {
          "type": [
            "string",
            "null"
          ]
        },
        "coverage": {
          "description": "Registry coverage for the IBAN's country: 'full' (complete national registry — an unknown bank means the account is likely unreachable), 'partial' (curated registry of major FR/GB/PT banks — an unknown bank is unknowable, so reachable stays null rather than a false negative), or 'structure_only' (country not in any registry — only IBAN structure is checked)",
          "type": [
            "string",
            "null"
          ]
        },
        "iban": {
          "type": "string"
        },
        "issue": {
          "description": "Diagnostic code when 'valid' is false — BAD_CHARACTERS, BAD_LENGTH, BAD_FORMAT, BAD_CHECKSUM, UNKNOWN_COUNTRY or INVALID_BBAN; null when the IBAN is valid",
          "type": [
            "string",
            "null"
          ]
        },
        "reachable": {
          "description": "Whether the bank is reachable for at least one SEPA scheme (see sepa_reachability)",
          "type": [
            "boolean",
            "null"
          ]
        },
        "sepa_reachability": {
          "properties": {
            "match": {
              "type": "string"
            },
            "schemes": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "sct": {
              "description": "Reachable for SEPA Credit Transfer (SCT); null when the BIC is unknown to the EPC registry",
              "type": "boolean"
            },
            "sct_inst": {
              "description": "Reachable for SEPA Instant Credit Transfer (SCT Inst); null when unknown",
              "type": "boolean"
            },
            "sdd_b2b": {
              "description": "Reachable for SEPA Direct Debit B2B (SDD B2B); null when unknown",
              "type": "boolean"
            },
            "sdd_core": {
              "description": "Reachable for SEPA Direct Debit Core (SDD Core); null when unknown",
              "type": "boolean"
            }
          },
          "required": [
            "match",
            "schemes",
            "sct",
            "sct_inst",
            "sdd_b2b",
            "sdd_core"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "valid": {
          "description": "Whether the IBAN passed structural and checksum (ISO 7064 mod-97) validation",
          "type": "boolean"
        }
      },
      "required": [
        "bank",
        "bank_code",
        "country",
        "coverage",
        "iban",
        "reachable",
        "sepa_reachability",
        "valid"
      ],
      "type": "object"
    },
    "provenance": {
      "properties": {
        "fetched_at": {
          "type": "string"
        },
        "freshness": {
          "properties": {
            "as_of": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            }
          },
          "required": [
            "as_of",
            "kind"
          ],
          "type": "object"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "fetched_at",
        "freshness",
        "source"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "provenance"
  ],
  "type": "object"
}