api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "already_valid": {
          "type": "boolean"
        },
        "ambiguous": {
          "type": "boolean"
        },
        "candidates": {
          "items": {
            "properties": {
              "bank_known": {
                "type": "boolean"
              },
              "iban": {
                "type": "string"
              },
              "resolution": {
                "properties": {
                  "bank": {
                    "properties": {
                      "bic": {
                        "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": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "reachable": {
                    "type": [
                      "boolean",
                      "null"
                    ]
                  },
                  "sepa_reachability": {
                    "type": [
                      "object",
                      "null"
                    ]
                  },
                  "valid": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "bank",
                  "bank_code",
                  "country",
                  "coverage",
                  "iban",
                  "reachable",
                  "valid"
                ],
                "type": "object"
              }
            },
            "required": [
              "bank_known",
              "iban",
              "resolution"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "input": {
          "type": "string"
        },
        "issue": {
          "description": "Why no candidate was returned, when 'candidates' is empty: 'TOO_AMBIGUOUS' (too many unreadable characters to decide) or 'UNREPAIRABLE' (no valid IBAN can be reconstructed). Null when at least one candidate is returned. An empty result is a SUCCESSFUL answer (HTTP 200), never an error.",
          "type": [
            "string",
            "null"
          ]
        },
        "repaired": {
          "type": "boolean"
        }
      },
      "required": [
        "already_valid",
        "ambiguous",
        "candidates",
        "input",
        "repaired"
      ],
      "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"
}