api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "bank": {
          "properties": {
            "bic": {
              "type": [
                "string",
                "null"
              ]
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "bic",
            "name"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "bank_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"
          ]
        },
        "screening": {
          "properties": {
            "bank_sanctioned": {
              "type": "boolean"
            },
            "hits": {
              "type": "array"
            },
            "jurisdiction": {
              "properties": {
                "level": {
                  "type": "string"
                },
                "lists": {
                  "type": "array"
                }
              },
              "required": [
                "level",
                "lists"
              ],
              "type": "object"
            },
            "risk": {
              "description": "Aggregated risk band: 'prohibited' (sanctioned bank or embargoed jurisdiction), 'high', 'elevated', 'clear' (no signal AND registry coverage sufficient to say so), or 'unknown' (bank not resolved in the registry — absence of a hit is not evidence of clearance). Never treat 'unknown' as 'clear'.",
              "type": "string"
            }
          },
          "required": [
            "bank_sanctioned",
            "hits",
            "jurisdiction",
            "risk"
          ],
          "type": [
            "object",
            "null"
          ]
        },
        "valid": {
          "type": "boolean"
        }
      },
      "required": [
        "bank",
        "bank_code",
        "country",
        "coverage",
        "iban",
        "screening",
        "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"
}