Atlar · Schema

CreateConnectionReportRequest

A manual upload of statement data for a connection. Use this when Atlar cannot fetch the data itself — a bank with no automatable channel, or a one-off backfill. What you send is stored verbatim and stays retrievable as the report's content, so it is the audit record of the upload. The JSON body may not exceed 10 MiB. Transactions are what usually push an upload towards that, so split a large backfill across requests rather than sending one request per day for a whole year.

CompanyFintechTreasuryPaymentsBankingCash ManagementFinancial OperationsERP Integration

Properties

Name Type Description
statements array One entry per account and local date. Entries are independent and may cover different accounts and different dates in the same request; each becomes its own statement. The request is accepted or rejec
View JSON Schema on GitHub

JSON Schema

atlar-create-connection-report-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/atlar/json-schema/atlar-create-connection-report-request-schema.json",
  "title": "CreateConnectionReportRequest",
  "description": "A manual upload of statement data for a connection.\n\nUse this when Atlar cannot fetch the data itself — a bank with no\nautomatable channel, or a one-off backfill. What you send is stored\nverbatim and stays retrievable as the report's content, so it is the\naudit record of the upload.\n\nThe JSON body may not exceed 10 MiB. Transactions are what usually push\nan upload towards that, so split a large backfill across requests rather\nthan sending one request per day for a whole year.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/atlar-connections-api-openapi.yml#/components/schemas/CreateConnectionReportRequest",
  "type": "object",
  "properties": {
    "statements": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CreateStatementRequest"
      },
      "minItems": 1,
      "maxItems": 100,
      "description": "One entry per account and local date. Entries are independent and may\ncover different accounts and different dates in the same request; each\nbecomes its own statement.\n\nThe request is accepted or rejected as a whole and forms a single\nreport, so group everything belonging to one upload together rather\nthan sending one request per statement. At most 100 entries — split\nlarger backfills across several requests."
    }
  },
  "required": [
    "statements"
  ],
  "$defs": {
    "AccountIdentifier": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/AccountIdentifierType"
        },
        "market": {
          "$ref": "#/$defs/MarketCode",
          "description": "The market of the `AccountIdentifier` specifies in which market-context the identifier should be treated.\n\nA `NUMBER` from Sweden does not look and does not validate in the same way as a `NUMBER` from GB. The market\ncode is, in most cases, the same as where the account itself is domiciled, but not necessarily. An examples\nof this discrepancy is Jersey which may have domiciled accounts with market `JE`, but the account identifier\nwould be an `IBAN` with country code `GB`."
        },
        "number": {
          "type": "string",
          "description": "The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific.",
          "minLength": 1,
          "maxLength": 255
        },
        "invalid": {
          "type": "boolean",
          "description": "Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules.",
          "readOnly": true
        }
      },
      "required": [
        "type",
        "market",
        "number"
      ]
    },
    "AccountIdentifierType": {
      "type": "string",
      "enum": [
        "IBAN",
        "NUMBER",
        "ADYEN",
        "AU_BPAY_BILLER_CODE",
        "DK_FIK",
        "INVESTMENT_NUMBER",
        "NATIONAL_ID_NUMBER",
        "PAYPAL",
        "PROPRIETARY",
        "SE_BANKGIRO",
        "SE_PLUSGIRO",
        "SOLDO",
        "WALLET_ADYEN_BALANCE_PLATFORM",
        "WALLET_AIRWALLEX",
        "WALLET_AIRWALLEX_NUMBER",
        "WALLET_CURRENCYCLOUD",
        "WALLET_FLASH_PAYMENTS",
        "WALLET_FREEMARKET",
        "WALLET_HYPERWALLET",
        "WALLET_INPAY",
        "WALLET_LEAD",
        "WALLET_MERCURY",
        "WALLET_MONEYCORP",
        "WALLET_PAYHAWK",
        "WALLET_REVOLUT",
        "WALLET_SKRILL",
        "WALLET_STRIPE",
        "WALLET_SWISSQUOTE",
        "WALLET_UNIT"
      ],
      "description": "Account Identifier type. Choose among:\n<ul>\n<li><code>IBAN</code> — IBAN</li>\n<li><code>NUMBER</code> — Account number</li>\n<li><code>ADYEN</code> — Adyen identifier</li>\n<li><code>AU_BPAY_BILLER_CODE</code> — Australian BPAY Biller Code</li>\n<li><code>DK_FIK</code> — FIK creditor number</li>\n<li><code>INVESTMENT_NUMBER</code> — Investment number</li>\n<li><code>NATIONAL_ID_NUMBER</code> — National Identification Number</li>\n<li><code>PAYPAL</code> — PayPal wallet identifier</li>\n<li><code>PROPRIETARY</code> — Proprietary identifier</li>\n<li><code>SE_BANKGIRO</code> — <a href=\"https://www.bankgirot.se/en/\">Bankgiro number</a></li>\n<li><code>SE_PLUSGIRO</code> — <a href=\"https://www.nordea.se/foretag/produkter/betala/plusgirot.html\">Plusgiro number</a></li>\n<li><code>SOLDO</code> — Soldo entity identifier</li>\n<li><code>WALLET_ADYEN_BALANCE_PLATFORM</code> — Adyen balance platform wallet identifier</li>\n<li><code>WALLET_AIRWALLEX</code> — Airwallex wallet identifier</li>\n<li><code>WALLET_AIRWALLEX_NUMBER</code> — Airwallex account number</li>\n<li><code>WALLET_CURRENCYCLOUD</code> — Currencycloud wallet identifier</li>\n<li><code>WALLET_FLASH_PAYMENTS</code> — Flash Payments wallet identifier</li>\n<li><code>WALLET_FREEMARKET</code> — Freemarket wallet identifier</li>\n<li><code>WALLET_HYPERWALLET</code> — Hyperwallet wallet identifier</li>\n<li><code>WALLET_INPAY</code> — Inpay account identifier</li>\n<li><code>WALLET_LEAD</code> — Lead wallet identifier</li>\n<li><code>WALLET_MERCURY</code> — Mercury wallet identifier</li>\n<li><code>WALLET_MONEYCORP</code> — Moneycorp wallet identifier</li>\n<li><code>WALLET_PAYHAWK</code> — Payhawk wallet identifier</li>\n<li><code>WALLET_REVOLUT</code> — Revolut wallet identifier</li>\n<li><code>WALLET_SKRILL</code> — Skrill wallet identifier</li>\n<li><code>WALLET_STRIPE</code> — Stripe wallet identifier</li>\n<li><code>WALLET_SWISSQUOTE</code> — Swissquote wallet identifier</li>\n<li><code>WALLET_UNIT</code> — Unit wallet identifier</li>\n</ul>\nFor further information please refer to <a href=\"https://docs.atlar.com/v2.0/docs/payment-details#account-identifiers\">Account Identifiers</a>"
    },
    "Address": {
      "description": "Postal address.",
      "type": "object",
      "properties": {
        "country": {
          "$ref": "#/$defs/CountryCode",
          "x-go-type-skip-optional-pointer": true
        },
        "countrySubdivision": {
          "$ref": "#/$defs/CountrySubdivision",
          "x-go-type-skip-optional-pointer": true
        },
        "city": {
          "type": "string",
          "maxLength": 64
        },
        "postalCode": {
          "type": "string",
          "maxLength": 16
        },
        "streetName": {
          "type": "string",
          "maxLength": 64
        },
        "streetNumber": {
          "type": "string",
          "maxLength": 16
        }
      }
    },
    "AmountInput": {
      "oneOf": [
        {
          "$ref": "#/$defs/AmountIntegerValueInput"
        },
        {
          "$ref": "#/$defs/AmountStringValueInput"
        }
      ]
    },
    "AmountIntegerValueInput": {
      "type": "object",
      "properties": {
        "currency": {
          "$ref": "#/$defs/CurrencyCode"
        },
        "value": {
          "description": "The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).",
          "type": "integer",
          "format": "int64"
        }
      },
      "required": [
        "currency",
        "value"
      ]
    },
    "AmountStringValueInput": {
      "type": "object",
      "properties": {
        "currency": {
          "$ref": "#/$defs/CurrencyCode"
        },
        "stringValue": {
          "description": "A string representation of the amount value, which will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with thousand separator) and always contains the dot `.` character as decimal separator.",
          "type": "string"
        }
      },
      "required": [
        "currency",
        "stringValue"
      ]
    },
    "BankAccountType": {
      "type": "string",
      "enum": [
        "WALLET",
        "SAVINGS",
        "CHECKING",
        "INVESTMENT"
      ]
    },
    "BankTransactionCode": {
      "type": "object",
      "description": "ISO 20022 Bank Transaction Code",
      "properties": {
        "domain": {
          "type": "string",
          "description": "ISO 20022 BTC Domain - Defines the business area of the underlying transaction, e.g. payments or cash management.",
          "maxLength": 4
        },
        "family": {
          "type": [
            "string",
            "null"
          ],
          "description": "ISO 20022 BTC Family - May for example define the type of transaction, e.g. credit transfer or direct debit.",
          "maxLength": 4,
          "x-omitempty": true
        },
        "subfamily": {
          "type": [
            "string",
            "null"
          ],
          "description": "ISO 20022 BTC Subfamily - May for example specify a scheme specific transaction type, e.g. SEPA credit transfer, or a Cross-Border credit transfer.",
          "maxLength": 4,
          "x-omitempty": true
        },
        "proprietary": {
          "$ref": "#/$defs/ProprietaryBankTransactionCode"
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Free-form textual description of the Bank Transaction Code.",
          "x-omitempty": true
        }
      },
      "required": [
        "domain"
      ]
    },
    "ConnAccountHolder": {
      "type": "object",
      "description": "The legal owner of a bank account.",
      "properties": {
        "legalName": {
          "type": "string",
          "description": "The account holder's name as registered with the bank. Use the\nregistered legal name rather than a trading name or an internal\nlabel — it is used when matching the account holder to a party Atlar\nalready knows."
        },
        "partyType": {
          "$ref": "#/$defs/PartyType",
          "description": "Whether the holder is a company or an individual. Omit it if the\nsource system does not distinguish the two rather than guessing."
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The holder's registered postal address, if the source reports one."
        },
        "nationalIdentifier": {
          "$ref": "#/$defs/NationalIdentifier",
          "description": "A national registration number for the holder: an organisation number\nfor a company, a personal identity number for an individual. Include\nit where you have it, since it identifies the holder far more\nprecisely than the name does."
        },
        "email": {
          "type": "string",
          "description": "The holder's email address, if the source reports one."
        }
      },
      "required": [
        "legalName"
      ]
    },
    "ConnAccountHolderInput": {
      "x-atlar-internal-comment": "Deliberately an alias rather than a trimmed copy: ConnAccountHolder has no\nreadOnly or otherwise output-only properties, so an input variant would be\nidentical to it. Do not split the two. ConnAccountHolderInput.Validate in\nconnectivity/contract/connectivityv2/holder.go is, via this alias, the\nValidate that BankStatementContent and ConvertedBankStatementContent rely\non, so splitting the schema drops their holder validation with no compile\nerror. connv2conv.From.AccountHolder also takes a ConnAccountHolder.\n",
      "$ref": "#/$defs/ConnAccountHolder"
    },
    "ConnBalanceInput": {
      "type": "object",
      "description": "One balance of an account, for one local calendar date.\n\nYou supply only a local date and whether the balance opens or closes that\nday; Atlar derives the exact instant from the account's timezone, so\n`OPEN` becomes the very start of the local day and `CLOSE` the very end\nof it. That is why there is no timestamp field here.",
      "properties": {
        "amount": {
          "$ref": "#/$defs/AmountInput",
          "description": "The balance itself, negative when the account is overdrawn.\n\nSupply either `value` (in the currency's minor units) or\n`stringValue` (a decimal string); if you supply both they must agree\nexactly. Must be in the same currency as the statement's\n`account.currency` — a JSON upload in another currency is accepted\nand then fails during processing, whereas the CSV upload rejects it\noutright."
        },
        "type": {
          "type": "string",
          "enum": [
            "BOOKED",
            "BOOKED_ADJUSTED",
            "AVAILABLE"
          ],
          "description": "Which balance this is.\n\n`BOOKED` is the settled ledger balance and the only one Atlar\nreconciles against, so every statement must carry a `BOOKED` `OPEN`\nand a `BOOKED` `CLOSE` — the day's net movement is derived from those\ntwo. `AVAILABLE` (what is usable right now, after holds and\noverdraft) and `BOOKED_ADJUSTED` are stored for reference only and\ncannot stand in for the booked pair."
        },
        "reportedType": {
          "type": "string",
          "enum": [
            "OPEN",
            "CLOSE"
          ],
          "description": "Whether this is the balance the day opened with or the one it closed\nwith. It is what fixes the balance's timestamp within `localDate`, so\nit has to reflect the real position: one date's closing balance and\nthe next date's opening balance should normally be equal."
        },
        "localDate": {
          "$ref": "#/$defs/Date",
          "description": "The local calendar date this balance belongs to, in the account's own\ntimezone. It must equal the statement's `period.localDate`; a\nstatement whose balances do not all share the statement's date is\nrejected during processing."
        }
      },
      "required": [
        "localDate",
        "reportedType",
        "type",
        "amount"
      ]
    },
    "ConnTransactionInput": {
      "type": "object",
      "description": "A single movement on the account, as reported by the source system.",
      "properties": {
        "uniqueID": {
          "type": "string",
          "description": "A stable identifier for this movement, unique within the account.\nReuse the source system's own transaction identifier if it has one.\n\nAtlar enforces that a `uniqueID` occurs at most once per account.\nRe-uploading the same movement unchanged is ignored and leaves the\nstored movement untouched — it is not an update — but reusing a\n`uniqueID` for a movement with a different amount or booked date is\na conflict and fails during processing. A `uniqueID` must therefore\nbe stable across re-uploads and must never be reused for a different\nmovement. Between 10 and 256 characters."
        },
        "amount": {
          "$ref": "#/$defs/AmountInput",
          "description": "The amount that hit the account, signed from the account's point of\nview: positive for a credit, negative for a debit.\n\nSupply either `value` (in the currency's minor units) or\n`stringValue` (a decimal string); if you supply both they must agree\nexactly. Must be in the same currency as `account.currency`."
        },
        "bookedDate": {
          "$ref": "#/$defs/Date",
          "description": "The local calendar date on which the bank booked the movement to its\nledger, in the account's own timezone. This is what ties the movement\nto a statement and to that day's booked balances, so it must equal\nthe `period.localDate` of the statement carrying it."
        },
        "valueDate": {
          "$ref": "#/$defs/Date",
          "x-go-type-skip-optional-pointer": true,
          "description": "The local calendar date on which the funds actually became available\nto, or were taken from, the account. It can differ from `bookedDate`,\ntypically for cross-border or weekend settlement. Omit it if the\nsource system does not report it rather than defaulting it to\n`bookedDate`."
        },
        "description": {
          "type": "string",
          "description": "The description as reported by the source system, verbatim. This is\nwhat a user sees when reconciling, so keep it human-readable and do\nnot substitute an internal code for it. It usually carries the same\ntext as the underlying payment's remittance information."
        },
        "status": {
          "type": "string",
          "enum": [
            "BOOKED"
          ],
          "description": "Only `BOOKED` is accepted. A statement is always a settled\nend-of-day statement, so it cannot carry pending movements."
        },
        "counterparty": {
          "$ref": "#/$defs/TransactionCounterparty",
          "description": "The other side of the movement, as reported by the source system.\nSend what the bank reports rather than a normalised or internal\nrepresentation of the party — it is used to match the movement to a\nknown counterparty. Omit the whole object when the source reports\nnothing about the other side."
        },
        "instructedAmount": {
          "$ref": "#/$defs/AmountInput",
          "description": "The amount the initiator of the payment originally instructed, when\nit differs from `amount` — typically the pre-conversion amount in the\ninstructed currency for a cross-currency payment, or the amount\nbefore the bank deducted charges. Omit it when it equals `amount`.\nSigned the same way as `amount`."
        },
        "references": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Payment references carried by the movement, keyed by reference kind.\nUse the well-known keys `endToEndId` and `mandateReference` where\nthey apply, so that Atlar can match the movement to a payment or a\nmandate; other keys are stored but not interpreted. At most 32\nentries."
        },
        "bankTransactionCode": {
          "$ref": "#/$defs/BankTransactionCode",
          "description": "The ISO 20022 Bank Transaction Code (`BkTxCd`) as reported by the\nsource system. Send the standard `domain`, `family` and `subfamily`\ncodes when available, and any bank-specific code in `proprietary`.\n`domain` may be left empty when the source only reports a\nproprietary code. Omit it when the source reports no transaction\ncode. `description` is ignored; Atlar derives it from `domain`,\n`family` and `subfamily`."
        }
      },
      "required": [
        "uniqueID",
        "amount",
        "bookedDate",
        "description",
        "status"
      ]
    },
    "CountryCode": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha2 country code.",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Z]{2,2}$"
    },
    "CountrySubdivision": {
      "type": "string",
      "description": "Country subdivision code (second part of the ISO 3166-2 code).\nE.g. state code `CA` for the state of California in the USA, `ON` for the province of Ontario in Canada, `NSW` for the state of New South Wales in Australia.\nISO 3166-2 codes can be found on the ISO website, for example, for the USA: https://www.iso.org/obp/ui/#iso:code:3166:US.\nIn the USA the state code is required for domestic payments, in Canada the province code is required for domestic payments.",
      "maxLength": 6,
      "pattern": "^[A-Z]{2,2}-[A-Z0-9]{1,3}$"
    },
    "CreateStatementRequest": {
      "type": "object",
      "description": "One account's settled end-of-day position for one local calendar date.\n\nA statement is identified by the account it names plus its local date, and\neverything in it — the period and every balance — must refer to that same\nlocal date. All dates are local calendar dates in the account's own\ntimezone, never UTC; see `account.timezone` for how that timezone is\nresolved and why it matters.\n\nAn account and local date can only be recorded once. Uploading a second\nstatement for a date that already has one does not correct or supersede\nit: the request is accepted, but the statement is discarded during\nprocessing and the first upload's balances stand. Get the figures right\nbefore uploading — restating a date that has already been recorded\nrequires Atlar to intervene.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "BOOKED"
          ],
          "description": "Only `BOOKED` is accepted. What you upload is treated as settled and\nfinal for the day, and safe to reconcile against. Upload intraday\nfigures once the day has closed rather than as they stand."
        },
        "period": {
          "$ref": "#/$defs/StatementPeriodInput",
          "description": "The local calendar date the statement covers. Together with the\naccount's timezone this determines the exact instants Atlar records as\nthe start and end of the statement."
        },
        "account": {
          "$ref": "#/$defs/StatementAccountInput",
          "description": "Which account the statement is for. Atlar matches it against the\naccounts on this connection by account identifier, and may discover a\npreviously unknown account from it — so send what the bank reports\nrather than a normalised or internal representation."
        },
        "holder": {
          "$ref": "#/$defs/ConnAccountHolderInput",
          "description": "The legal owner of the account. Required even when Atlar already knows\nthe account, because it forms part of the statement record."
        },
        "balances": {
          "type": "array",
          "minItems": 1,
          "x-omitempty": true,
          "items": {
            "$ref": "#/$defs/ConnBalanceInput"
          },
          "description": "The account's balances for the statement's local date.\n\nAlways send at least the day's opening and closing booked balances:\none entry with `type: BOOKED` and `reportedType: OPEN`, and one with\n`type: BOOKED` and `reportedType: CLOSE`. Both are needed for the\nstatement to be processed — without them the request is accepted and\nthen fails during processing.\n\nEvery entry's `localDate` must equal `period.localDate`, and the\ncombination of `type` and `reportedType` must be unique across the\narray, so a statement cannot carry two closing booked balances."
        },
        "transactions": {
          "type": "array",
          "maxItems": 1000,
          "x-omitempty": true,
          "items": {
            "$ref": "#/$defs/ConnTransactionInput"
          },
          "description": "The individual movements the day's booked balances are made up of.\nOptional, but send them whenever the source system reports them —\nwithout them a statement only shows that the balance moved, not what\nmoved it, and nothing can be reconciled against a payment.\n\nWhen you do send them they must account for the day in full: each\n`uniqueID` may occur only once in the statement, each `bookedDate`\nmust equal `period.localDate`, each `amount.currency` must equal\n`account.currency`, and the signed sum of the entries — credits\npositive, debits negative — must equal the closing booked balance\nminus the opening one exactly. A request that breaks any of these is\nrejected. At most 1000 entries per statement — a day with more\nmovements than that cannot be split across two statements, since an\naccount and local date can only be recorded once, so contact Atlar.\n\nIf you omit the array, Atlar reconstructs the day's net movement from\nthe balances — a single transaction for the closing booked balance\nminus the opening one, a credit if that is positive and a debit if it\nis negative, dated on the statement's local date. If the two balances\nare equal, the day gets no transaction at all."
        }
      },
      "required": [
        "type",
        "period",
        "account",
        "holder",
        "balances"
      ]
    },
    "CurrencyCode": {
      "type": "string",
      "description": "Three-letter ISO 4217 currency code.",
      "minLength": 3,
      "maxLength": 3,
      "pattern": "^[A-Z]{3,3}$"
    },
    "Date": {
      "type": "string",
      "format": "date",
      "description": "`full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`."
    },
    "MarketCode": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha2 country code.",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Z]{2,2}$"
    },
    "NationalIdentifier": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the national identifier.",
          "enum": [
            "CIVIC",
            "COMPANY"
          ]
        },
        "market": {
          "$ref": "#/$defs/MarketCode"
        },
        "number": {
          "type": "string",
          "description": "The identifier itself."
        }
      },
      "required": [
        "type",
        "market",
        "number"
      ]
    },
    "PartyType": {
      "type": "string",
      "description": "The legal type of a party",
      "enum": [
        "INDIVIDUAL",
        "COMPANY"
      ]
    },
    "ProprietaryBankTransactionCode": {
      "type": "object",
      "description": "Proprietary bank transaction codes are provided when the bank provides a proprietary transaction code. This field will be set as the code provided by the bank.",
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 35,
          "x-omitempty": true
        },
        "issuer": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 35,
          "x-omitempty": true
        }
      }
    },
    "ReferencedAccount": {
      "type": "object",
      "description": "An account on the other side of a movement, as the source system reports it.",
      "properties": {
        "rawIdentifierNumber": {
          "type": "string",
          "description": "The account number exactly as the source system reports it, neither\nparsed nor normalised — an IBAN, a local account number, a wallet\nreference. Atlar parses it itself in order to match the account, so\nsend it verbatim rather than a cleaned-up form."
        },
        "market": {
          "$ref": "#/$defs/MarketCode",
          "description": "The market the account is domiciled in, if the source reports it."
        },
        "currency": {
          "$ref": "#/$defs/CurrencyCode",
          "description": "The account's own currency, if the source reports it."
        },
        "identifiers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AccountIdentifier"
          },
          "minItems": 1,
          "maxItems": 10,
          "uniqueItems": true,
          "description": "How the source system identifies the account, if known beyond\nrawIdentifierNumber — e.g. a parsed IBAN alongside a local number.",
          "x-omitempty": true
        },
        "routing": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RoutingIdentifier"
          },
          "maxItems": 10,
          "uniqueItems": true,
          "x-omitempty": true,
          "description": "How the account's bank is identified, if known — a BIC, a sort code,\na routing number."
        }
      },
      "required": [
        "rawIdentifierNumber"
      ]
    },
    "ReferencedParty": {
      "type": "object",
      "description": "A party on the other side of a movement, as the source system reports it.",
      "properties": {
        "legalName": {
          "type": "string",
          "description": "The party's name as the source system reports it, not a normalised or\ninternal label. It is used to match the movement to a counterparty\nAtlar already knows."
        },
        "partyType": {
          "$ref": "#/$defs/PartyType",
          "description": "Whether the party is a company or an individual. Omit it if the source\ndoes not distinguish the two rather than guessing."
        },
        "address": {
          "$ref": "#/$defs/Address",
          "description": "The party's address, split into its components. Send `rawAddressLines`\nalongside it, so the parsed form can be checked against the original."
        },
        "nationalIdentifier": {
          "$ref": "#/$defs/NationalIdentifier",
          "description": "An organisation number or personal identity number for the party. It\nidentifies the party far more precisely than the name does."
        },
        "rawAddressLines": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The address exactly as the source system reports it, one entry per\nline, neither parsed nor reordered.",
          "x-omitempty": true
        }
      },
      "required": [
        "legalName"
      ]
    },
    "RoutingConstraints": {
      "description": "Constraints on a `RoutingIdentifier`.",
      "type": "object",
      "properties": {
        "accountNumberType": {
          "$ref": "#/$defs/AccountIdentifierType",
          "x-go-type-skip-optional-pointer": true
        },
        "scheme": {
          "type": "string"
        }
      }
    },
    "RoutingIdentifier": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/RoutingIdentifierType"
        },
        "number": {
          "type": "string",
          "description": "The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code.",
          "minLength": 1,
          "maxLength": 255
        },
        "invalid": {
          "type": "boolean",
          "description": "Will be `true` if the routing identifier is invalid according to Atlar validation rules.",
          "readOnly": true
        },
        "constraints": {
          "$ref": "#/$defs/RoutingConstraints"
        }
      },
      "required": [
        "type",
        "number"
      ]
    },
    "RoutingIdentifierType": {
      "type": "string",
      "enum": [
        "BIC",
        "AT_BLZ",
        "AU_BSB",
        "BD_BRN",
        "BR_BRANCH",
        "BR_COMPE",
        "BR_ISP",
        "CA_CPA",
        "CH_BCC",
        "CH_SIC",
        "CL_SBIF",
        "CN_APS",
        "CZ_NBC",
        "DE_BLZ",
        "ES_NCC",
        "GB_DSC",
        "GR_BIC",
        "HK_NCC",
        "IE_NCC",
        "IL_NCC",
        "IN_FSC",
        "IT_NCC",
        "JP_ZGN",
        "KR_BOK",
        "KR_KFTC",
        "MX_ABM",
        "MY_NCC",
        "NZ_NCC",
        "PH_BRSTN",
        "PL_KNR",
        "PT_NCC",
        "RU_CBC",
        "SE_SBA",
        "SG_IBG",
        "TH_CBC",
        "TW_NCC",
        "US_ABA",
        "US_PID",
        "VN_CITAD",
        "ZA_NCC"
      ],
      "description": "A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments."
    },
    "StatementAccountInput": {
      "type": "object",
      "description": "Identifies the account a statement belongs to, as the source system\nreports it.",
      "properties": {
        "market": {
          "$ref": "#/$defs/MarketCode",
          "description": "The market the account is domiciled in. This drives market-specific\nvalidation of the account identifiers and is the first fallback for\nresolving the account's timezone, so it is worth getting right even\nthough it is not always the country in the account's IBAN."
        },
        "timezone": {
          "$ref": "#/$defs/Timezone",
          "description": "The IANA timezone the account's business day is measured in, for\nexample `Europe/Stockholm`.\n\nSet this whenever you can: it is what turns the local dates you send\ninto the exact instants Atlar stores, so a wrong value can move a\nstatement onto the neighbouring day. If you omit it, Atlar falls back\nto the timezone of `market`, and then to the timezone of a `BIC` in\n`routing`. If none of those resolves, the request is accepted and then\nfails during processing."
        },
        "currency": {
          "$ref": "#/$defs/CurrencyCode",
          "description": "The account's own currency. Every balance in the statement must be in\nthis currency; a statement whose balances disagree is accepted and\nthen fails during processing."
        },
        "identifiers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AccountIdentifier"
          },
          "minItems": 1,
          "maxItems": 10,
          "uniqueItems": true,
          "description": "How the ba

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://artifacts.apis.io/atlar/json-schema/atlar-create-connection-report-request-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/atlar-create-connection-report-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.