{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/atlar/json-schema/atlar-account-schema.json",
  "title": "Account",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/atlar-accounts-api-openapi.yml#/components/schemas/Account",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/ResourceID",
      "readOnly": true
    },
    "organizationId": {
      "$ref": "#/$defs/OrganizationID",
      "readOnly": true
    },
    "thirdPartyId": {
      "description": "ID of the associated third-party, e.g. the bank in which the account is held.",
      "type": "string",
      "readOnly": true
    },
    "affiliationId": {
      "description": "ID of the affiliation. An affiliation is and describes the relationship between the legal entity (`entityId`) owning this account and the third-party (`thirdPartyId`) where the account is held (e.g. a bank).",
      "type": "string",
      "readOnly": true
    },
    "entityId": {
      "description": "ID of the associated legal Entity.",
      "type": "string",
      "readOnly": true
    },
    "market": {
      "$ref": "#/$defs/MarketCode",
      "readOnly": true
    },
    "currency": {
      "$ref": "#/$defs/CurrencyCode",
      "readOnly": true
    },
    "name": {
      "description": "Name of the account automatically populated by Atlar.",
      "type": "string",
      "maxLength": 255,
      "readOnly": true
    },
    "alias": {
      "description": "An additional name, an alias, for the account.",
      "type": "string",
      "maxLength": 255,
      "x-omitempty": true,
      "readOnly": true
    },
    "identifiers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AccountIdentifier"
      },
      "minItems": 1,
      "uniqueItems": true,
      "readOnly": true
    },
    "routing": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/RoutingIdentifier"
      },
      "uniqueItems": true,
      "maxItems": 5,
      "readOnly": true
    },
    "type": {
      "$ref": "#/$defs/BankAccountType"
    },
    "status": {
      "$ref": "#/$defs/AccountStatus"
    },
    "fictive": {
      "type": "boolean",
      "description": "Indicates whether the account is a fictive/test account. This will be `true` for accounts associated with the Atlar _Testbank_.",
      "readOnly": true
    },
    "externalId": {
      "$ref": "#/$defs/ExternalID",
      "readOnly": true
    },
    "metadata": {
      "$ref": "#/$defs/Metadata",
      "readOnly": true
    },
    "paymentOptions": {
      "$ref": "#/$defs/PaymentOptions",
      "readOnly": true
    },
    "version": {
      "$ref": "#/$defs/ResourceVersion"
    },
    "etag": {
      "$ref": "#/$defs/ETag"
    },
    "created": {
      "$ref": "#/$defs/CreatedTimestamp"
    },
    "updated": {
      "$ref": "#/$defs/UpdatedTimestamp"
    },
    "closed": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the account was closed. Only present if account `status` is `CLOSED`.\n",
      "readOnly": true
    },
    "provisionState": {
      "$ref": "#/$defs/ProvisionState",
      "description": "New accounts start in `UNPROVISIONED` state, awaiting a decision to provision or ignore them.\nWhile unprovisioned, data ingestion (balances, transactions, etc.) is paused.\nAccounts transitioned to `IGNORED` are hidden and no data is ingested.\nAccounts transitioned to `PROVISIONED` appear normally and data ingestion begins.\n"
    }
  },
  "required": [
    "id",
    "organizationId",
    "entityId",
    "thirdPartyId",
    "affiliationId",
    "market",
    "currency",
    "identifiers",
    "routing",
    "name",
    "status",
    "fictive",
    "created",
    "updated",
    "version",
    "etag",
    "provisionState"
  ],
  "$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>"
    },
    "AccountStatus": {
      "description": "Operational status of the account with the holding financial institution.",
      "type": "string",
      "enum": [
        "OPEN",
        "CLOSED"
      ]
    },
    "BankAccountType": {
      "type": "string",
      "enum": [
        "WALLET",
        "SAVINGS",
        "CHECKING",
        "INVESTMENT"
      ]
    },
    "CitiWorldlinkInstrument": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/InstrumentType"
        },
        "citiWorldlinkId": {
          "type": "string",
          "description": "The WorldLink ID assigned to the account to initiate payments."
        }
      },
      "required": [
        "type",
        "citiWorldlinkId"
      ]
    },
    "CreatedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the resource was created.",
      "readOnly": true
    },
    "CurrencyCode": {
      "type": "string",
      "description": "Three-letter ISO 4217 currency code.",
      "minLength": 3,
      "maxLength": 3,
      "pattern": "^[A-Z]{3,3}$"
    },
    "ETag": {
      "type": "string",
      "description": "[ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the\nresource version. This can be passed along in `If-Match` HTTP\nheader when updating a resource to perform a conditional\nupdate.",
      "pattern": "^version:\\d{1,4}$",
      "readOnly": true
    },
    "ExternalID": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9._\\-+=]{1,64}$",
      "description": "External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`.",
      "x-omitempty": true
    },
    "Instrument": {
      "type": "object",
      "description": "The payment instrument used to initiate the payment. For example Citi has a proprietary payment instrument called WorldLink, which can be used to initiate payments.",
      "oneOf": [
        {
          "$ref": "#/$defs/CitiWorldlinkInstrument"
        },
        {
          "$ref": "#/$defs/USACHInstrument"
        }
      ]
    },
    "InstrumentType": {
      "type": "string",
      "description": "The type of the payment instrument.",
      "enum": [
        "US_ACH",
        "CITI_WORLDLINK"
      ]
    },
    "MarketCode": {
      "type": "string",
      "description": "Two-letter ISO 3166-1 alpha2 country code.",
      "minLength": 2,
      "maxLength": 2,
      "pattern": "^[A-Z]{2,2}$"
    },
    "Metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      },
      "description": "Metadata is a `string-string` key-value container that\ncan be used to store information known at the time of resource\ncreation. This can be retrieved later on, for instance when a\npayment or expected transaction is reconciled with the booked\ntransaction on the bank statement.\n\nMetadata can have at most 20 entries. Keys may have a\nmaximum length of 64 chars and values a maximum length of 512\nchars.\n\nBy default, this field is optional. It is possible to make it\nrequired in the Atlar Dashboard by visiting the [Metadata keys\npage](https://app.atlar.com/metadata-keys). Requirement rules\ncan be specified per API resource. Both the Dashboard and the\nAPI will then enforce these rules and give validation errors\nwhen the required fields are not set.",
      "maxProperties": 20,
      "x-omitempty": true
    },
    "OrganizationID": {
      "type": "string",
      "description": "Unique resource identifier for an Organization."
    },
    "PaymentOptions": {
      "type": "object",
      "properties": {
        "instruments": {
          "type": "array",
          "x-omitempty": true,
          "items": {
            "$ref": "#/$defs/Instrument"
          }
        },
        "initiatorId": {
          "type": "string"
        },
        "disabled": {
          "type": "boolean",
          "description": "When true, initiating credit transfers from this account is blocked.",
          "readOnly": true
        }
      }
    },
    "ProvisionState": {
      "type": "string",
      "enum": [
        "UNPROVISIONED",
        "IGNORED",
        "PROVISIONED"
      ]
    },
    "ResourceID": {
      "type": "string",
      "description": "Unique resource identifier.",
      "minLength": 32,
      "maxLength": 64
    },
    "ResourceVersion": {
      "type": "integer",
      "description": "Resource version. Starts at value `1` when the resource is\ncreated and increases by one for each successive update.",
      "minimum": 1,
      "readOnly": true
    },
    "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."
    },
    "USACHInstrument": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/InstrumentType"
        },
        "usAchCompanyId": {
          "type": "string",
          "description": "The US ACH Company ID assigned to the account to initiate US ACH payments."
        },
        "usAchCompanyName": {
          "type": "string",
          "description": "Optional US ACH Company Name override. When set, it is used as the debtor name (Dbtr/Nm)\non outgoing US ACH payments from this account instead of the account holder's legal name.\nOnly used for US ACH payments.\n"
        },
        "usAchImmediateOrigin": {
          "type": "string",
          "description": "Optional US ACH Immediate Origin. When set, it populates the Immediate Origin field of the\nNACHA file header instead of the US ACH Company ID. Some banks assign an Immediate Origin\nthat is distinct from the Company ID. Only used for US ACH payments.\n"
        }
      },
      "required": [
        "type",
        "usAchCompanyId"
      ]
    },
    "UpdatedTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Time at which the resource was last updated.",
      "readOnly": true
    }
  }
}