---
updatedAt: 2026-09-10T05:58:12.000Z
agentTools:
  projectIndex: https://devhub.audd.digital/llms.txt
---

# Create a bank account

Creates a bank account for your company. The same endpoint creates both kinds of account used by the deposit and withdrawal flows, and subType selects which:

- subType DEPOSIT, using the bankProviderType value AUDD issues you during onboarding, creates an internal virtual account that receives AUD. The provider allocates bsb, accountNumber, iban and reference, so do not send bank details yourself.
- subType WITHDRAWAL with bankProviderType NONE records an external account that AUDD pays out to. You must supply the bank details, and should supply internalBankAccountId to link it to the virtual account holding the funds.

Any other bankProviderType value belongs to a legacy integration and is not available.

A DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are required as before. Other account types keep their existing address-line contract.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "staging-distributor-api-gateway",
    "version": "v1.0"
  },
  "servers": [
    {
      "url": "https://api.sandbox.audd.digital",
      "x-amazon-apigateway-endpoint-configuration": {
        "disableExecuteApiEndpoint": true
      }
    }
  ],
  "paths": {
    "/bank-accounts": {
      "post": {
        "tags": [
          "Bank Account"
        ],
        "summary": "Create a bank account",
        "description": "Creates a bank account for your company. The same endpoint creates both kinds of account used by the deposit and withdrawal flows, and subType selects which:\n\n- subType DEPOSIT, using the bankProviderType value AUDD issues you during onboarding, creates an internal virtual account that receives AUD. The provider allocates bsb, accountNumber, iban and reference, so do not send bank details yourself.\n- subType WITHDRAWAL with bankProviderType NONE records an external account that AUDD pays out to. You must supply the bank details, and should supply internalBankAccountId to link it to the virtual account holding the funds.\n\nAny other bankProviderType value belongs to a legacy integration and is not available.\n\nA DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are required as before. Other account types keep their existing address-line contract.",
        "operationId": "Create a bank account",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Create bank account request. A DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are the address, with the rules described on each line. Other account types keep their existing address-line behaviour.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateBankAccountRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success. The account is created and returned. Note that this endpoint returns 200 rather than 201.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BankAccountDetailResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input. The body carries a messageKey identifying the rule that failed: bank_account.company_required, bank_account.nickname_required, bank_account.bank_provider_type_required, bank_account.sub_type_required, bank_account.bank_details_required (bankProviderType NONE or subType WITHDRAWAL must carry bsb, or swiftCode with iban or accountNumber), bank_account.bsb_and_swift_mutually_exclusive, bank_account.invalid_bsb_format, bank_account.invalid_account_number, bank_account.invalid_swift_code, bank_account.invalid_iban.\n\nA DEPOSIT virtual account additionally validates customer details, and those failures return an errors array of {field, messageKey, message} objects naming each offending field, with messageKey carrying the human-readable reason rather than a dotted key. Address failures name the offending field: a structuredAddress field when one is sent, for example structuredAddress.postCode with \"Postcode is required\" when the postcode is missing, otherwise addressLine1 to addressLine3. Customer details rejected by the provider rather than locally, such as a combined account holder name over 35 characters, return messageKey bank_account.invalid_customer_details with the provider's own message.",
            "content": {}
          },
          "401": {
            "description": "Unauthorized. The bearer token is missing, expired or invalid.",
            "content": {}
          },
          "404": {
            "description": "Not found. The companyId, or an internalBankAccountId that was supplied, does not resolve to a record you can see.",
            "content": {}
          },
          "409": {
            "description": "Bank account already exists. Returned with messageKey bank_account.pay_id_already_exists when the payId is already in use by another account. Note that a duplicate bsb and accountNumber pair is currently accepted on create rather than rejected here.",
            "content": {}
          },
          "500": {
            "description": "Internal server error",
            "content": {}
          }
        },
        "x-amazon-apigateway-request-validator": "Validate query string parameters and headers",
        "x-amazon-apigateway-integration": {
          "type": "http",
          "uri": "http://staging-green-nlb-7f4cace91fc31ab6.elb.ap-southeast-2.amazonaws.com:8007/bank-mgmt/api/bank-accounts",
          "connectionId": "pdxvhz",
          "httpMethod": "POST",
          "responses": {
            "400": {
              "statusCode": "400"
            },
            "401": {
              "statusCode": "401"
            },
            "404": {
              "statusCode": "404"
            },
            "409": {
              "statusCode": "409"
            },
            "500": {
              "statusCode": "500"
            },
            "default": {
              "statusCode": "200"
            }
          },
          "requestParameters": {
            "integration.request.header.Authorization": "method.request.header.Authorization",
            "integration.request.header.X-Forwarded-For": "context.identity.sourceIp"
          },
          "connectionType": "VPC_LINK",
          "passthroughBehavior": "when_no_match"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BankAccountDetailResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The account id. Use it as bankAccountId when minting, srcBankAccountId or destBankAccountId when withdrawing, and internalBankAccountId when linking a withdrawal account."
          },
          "bsb": {
            "type": "string",
            "description": "BSB, hyphenated. Allocated by the provider for a DEPOSIT virtual account."
          },
          "accountNumber": {
            "type": "string",
            "description": "Account number. Allocated by the provider for a DEPOSIT virtual account."
          },
          "iban": {
            "type": "string",
            "description": "IBAN, where the account has one. The provider allocates one for virtual accounts."
          },
          "swiftCode": {
            "type": "string",
            "description": "SWIFT/BIC, for an international external account. Null otherwise."
          },
          "payId": {
            "type": "string",
            "description": "PayID, where set. Null unless the account's provider supports PayID."
          },
          "reference": {
            "type": "string",
            "description": "A payment reference allocated to this account when it was created, returned for your own reconciliation. Incoming deposits are neither matched against it nor required to quote it."
          },
          "nickname": {
            "type": "string",
            "description": "The friendly name supplied on creation."
          },
          "type": {
            "type": "string",
            "description": "Account type. Accounts belonging to your company are DISTRIBUTOR. Other values may appear for accounts shared with you and should be tolerated rather than relied on."
          },
          "subType": {
            "type": "string",
            "description": "Account sub type. DEPOSIT and WITHDRAWAL are the accounts you create. REMITTER accounts are created automatically, one per party that sends funds to your virtual accounts, so expect to see accounts here that you did not create; handle this value even though you cannot send it.",
            "enum": [
              "DEPOSIT",
              "WITHDRAWAL",
              "REMITTER"
            ]
          },
          "currency": {
            "type": "string",
            "description": "Account currency.",
            "enum": [
              "AUD"
            ]
          },
          "status": {
            "type": "string",
            "description": "Account status. Only an ACTIVE account can be used to mint or withdraw. A REMITTER account is created PENDING and becomes ACTIVE as soon as the deposit that created it clears, so in practice you will see ACTIVE; it stays PENDING only while a hold applies. Treat the list as non-exhaustive: additional statuses exist for AUDD-internal handling and may appear.",
            "enum": [
              "PENDING",
              "ACTIVE",
              "SUSPENDED",
              "FAILED"
            ]
          },
          "providerType": {
            "type": "string",
            "description": "The bank provider backing this account: the value AUDD issued you, for a virtual account, or NONE for an external account you registered. Note the name difference between the request field bankProviderType and this response field providerType."
          },
          "balance": {
            "type": "number",
            "description": "Available balance in the account currency. Note the name: the field is balance, singular."
          },
          "depositFee": {
            "$ref": "#/components/schemas/FeeResponse"
          },
          "withdrawFee": {
            "$ref": "#/components/schemas/FeeResponse"
          },
          "company": {
            "$ref": "#/components/schemas/CompanyModel"
          },
          "createdBy": {
            "$ref": "#/components/schemas/UserModel"
          },
          "createdAt": {
            "type": "string",
            "description": "When the account was created.",
            "format": "date-time"
          },
          "accountHolderName": {
            "type": "string",
            "description": "Full account holder name, where supplied."
          },
          "accountHolderFirstname": {
            "type": "string",
            "description": "Account holder given name, where supplied."
          },
          "accountHolderLastname": {
            "type": "string",
            "description": "Account holder family name, where supplied."
          },
          "address": {
            "type": "string",
            "description": "The account's address lines, joined with newlines. When the account has a structuredAddress, the lines are generated from it, and structuredAddress returns the address as separate fields. Note that the request takes addressLine1, addressLine2 and addressLine3 separately but the response returns a single string."
          },
          "structuredAddress": {
            "$ref": "#/components/schemas/StructuredAddress"
          },
          "linkedAccounts": {
            "type": "array",
            "description": "The other accounts in the same group. For a deposit virtual account these are the accounts attached to it; for an attached account this is its virtual account together with the other accounts attached to that same one.",
            "items": {
              "type": "object"
            }
          },
          "autoMintEnabled": {
            "type": "boolean",
            "description": "When true, AUD credited to this account is minted to AUDD automatically once the deposit clears, with no POST /trades/buy call. If that automatic mint fails, the AUD stays credited to the account, no AUDD is issued, and the mint is not retried."
          },
          "autoBurnEnabled": {
            "type": "boolean",
            "description": "Marks this account as the one that receives the AUD when a burn settles automatically, that is when AUDD reaches the burn wallet without a matching POST /trades/sell. At most one account per company carries this flag, and an automatic burn fails if none does."
          },
          "nameMatchingEnabled": {
            "type": "boolean",
            "description": "Whether the sender's name on an incoming deposit is checked against this account's registered holder names. The comparison is fuzzy and also tried with spaces removed. Null means the company default applies."
          },
          "referenceCheckingEnabled": {
            "type": "boolean",
            "description": "When enabled, the description on an incoming deposit is screened against a list of blocked terms; a match rejects the deposit and flags it for review rather than crediting it. Terms of three characters or fewer, and purely numeric terms, must equal the whole description, while longer terms match anywhere within it. This does not require a deposit to quote this account's reference. Null means the company default applies, and screening is on when neither is set."
          },
          "nameMatchingEnabledResolved": {
            "type": "boolean",
            "description": "The effective value of nameMatchingEnabled for this account once the company default has been applied. Read this rather than nameMatchingEnabled to know whether the check is actually on."
          },
          "referenceCheckingEnabledResolved": {
            "type": "boolean",
            "description": "The effective value of referenceCheckingEnabled once the company default has been applied. Read this rather than referenceCheckingEnabled to know whether screening is actually on."
          },
          "depositFeeResolved": {
            "$ref": "#/components/schemas/FeeResponse"
          },
          "withdrawFeeResolved": {
            "$ref": "#/components/schemas/FeeResponse"
          }
        },
        "description": "A bank account. Responses may also carry AUDD-internal fields not listed here; do not depend on them."
      },
      "StructuredAddress": {
        "type": "object",
        "properties": {
          "unit": {
            "maxLength": 70,
            "type": "string",
            "description": "Unit, suite or flat (ISO 20022 Room), e.g. \"4\"."
          },
          "level": {
            "maxLength": 70,
            "type": "string",
            "description": "Floor or level (ISO 20022 Floor), e.g. \"30\"."
          },
          "buildingName": {
            "maxLength": 35,
            "type": "string",
            "description": "Building name (ISO 20022 BuildingName)."
          },
          "buildingNumber": {
            "maxLength": 16,
            "type": "string",
            "description": "Street number (ISO 20022 BuildingNumber), e.g. \"91\", \"12-18\" or \"91A\"."
          },
          "streetName": {
            "maxLength": 70,
            "type": "string",
            "description": "Street name including the street type (ISO 20022 StreetName), e.g. \"King William Street\"."
          },
          "postCode": {
            "maxLength": 16,
            "type": "string",
            "description": "Postcode (ISO 20022 PostCode), e.g. \"5000\"."
          },
          "locality": {
            "maxLength": 35,
            "type": "string",
            "description": "Suburb or town (ISO 20022 TownName), e.g. \"Adelaide\". Use the suburb or town, not the metropolitan city."
          },
          "state": {
            "maxLength": 35,
            "type": "string",
            "description": "State or territory (ISO 20022 CountrySubDivision), e.g. \"SA\"."
          },
          "countryCode": {
            "pattern": "^[A-Z]{2}$",
            "type": "string",
            "description": "ISO 3166-1 alpha-2 country code, e.g. \"AU\"."
          }
        },
        "description": "Structured postal address. Which fields are required depends on the request (see the referencing schema); on a DEPOSIT virtual account, a structuredAddress with any field set requires locality, state, postCode, countryCode and streetName (a building name or number alone is not enough). Together, unit, level, buildingName, buildingNumber, streetName, state and postCode must also fit two lines of at most 70 characters without splitting a word; a longer address is rejected with \"Structured address is too long. Shorten it, for example by abbreviating the street type\". On a DEPOSIT virtual account every field must match ^[a-zA-Z0-9/\\-?:().' +]+$ (no commas or ampersands) and must not start with whitespace, and PO Box addresses are rejected. In bank account responses structuredAddress is null when no structured address is stored for the account."
      },
      "CreateBankAccountRequest": {
        "required": [
          "companyId",
          "nickname"
        ],
        "type": "object",
        "properties": {
          "companyId": {
            "type": "string",
            "description": "Your distributor company id."
          },
          "nickname": {
            "maxLength": 255,
            "type": "string",
            "description": "A friendly name for the account. Required. Printable ASCII only."
          },
          "currency": {
            "type": "string",
            "description": "Defaults to AUD when omitted.",
            "enum": [
              "AUD"
            ],
            "default": "AUD"
          },
          "type": {
            "type": "string",
            "description": "DISTRIBUTOR, which is also the default when omitted. Other account types exist for AUDD-internal use and are not available to client integrations.",
            "enum": [
              "DISTRIBUTOR"
            ],
            "default": "DISTRIBUTOR"
          },
          "subType": {
            "type": "string",
            "description": "Required. DEPOSIT creates an internal virtual account that receives AUD; WITHDRAWAL records an external account AUDD pays out to. Accounts representing the parties who send you funds are created automatically when a deposit arrives, and are not created through this endpoint.",
            "enum": [
              "DEPOSIT",
              "WITHDRAWAL"
            ]
          },
          "bankProviderType": {
            "type": "string",
            "description": "Required. For a DEPOSIT virtual account, use the value AUDD issues you during onboarding; the provider then allocates the bank details. For an external WITHDRAWAL or REMITTER account whose details you supply yourself, use NONE."
          },
          "bsb": {
            "pattern": "^[0-9]{3}-[0-9]{3}$",
            "type": "string",
            "description": "Australian BSB, including the hyphen. Mutually exclusive with swiftCode. Required, with accountNumber, for a domestic external account. Do not send for a DEPOSIT virtual account: the provider allocates it."
          },
          "accountNumber": {
            "pattern": "^[0-9]+$",
            "type": "string",
            "description": "Account number, digits only. Do not send for a DEPOSIT virtual account."
          },
          "swiftCode": {
            "maxLength": 255,
            "pattern": "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$",
            "type": "string",
            "description": "SWIFT/BIC for an international account. Mutually exclusive with bsb, and must be accompanied by iban or accountNumber."
          },
          "iban": {
            "maxLength": 255,
            "pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$",
            "type": "string",
            "description": "IBAN for an international account, used with swiftCode."
          },
          "internalBankAccountId": {
            "type": "string",
            "description": "For subType WITHDRAWAL, the id of the DEPOSIT virtual account this withdrawal account is linked to, so proceeds settle against the right account. Not currently enforced when bankProviderType is NONE, but supply it: the withdrawal flow depends on the link."
          },
          "accountHolderName": {
            "maxLength": 255,
            "type": "string",
            "description": "Full account holder name for an external account. Used as the preferred creditor name on outgoing payments; when absent, accountHolderFirstname and accountHolderLastname are used, then nickname. On a DEPOSIT virtual account it must also be at most 35 characters and use only letters, digits, / - ? : ( ) . ' and spaces, with no leading space."
          },
          "accountHolderFirstname": {
            "maxLength": 255,
            "type": "string",
            "description": "Given name of the underlying customer. Required for a DEPOSIT virtual account, and optional otherwise. Must match the name on the bank account that will send funds, or deposits may not clear. On a DEPOSIT virtual account: at most 35 characters, only letters, digits, / - ? : ( ) . ' and spaces, no leading space, and critically the provider also caps accountHolderFirstname plus a space plus accountHolderLastname at 35 characters combined. Exceeding the combined limit passes local validation and is then rejected upstream with messageKey bank_account.invalid_customer_details."
          },
          "accountHolderLastname": {
            "maxLength": 255,
            "type": "string",
            "description": "Family name of the underlying customer. Required for a DEPOSIT virtual account, and optional otherwise. Same character, length and combined-name rules as accountHolderFirstname."
          },
          "addressLine1": {
            "maxLength": 255,
            "type": "string",
            "description": "Street address of the underlying customer. On a DEPOSIT virtual account: at most 35 characters, only letters, digits, / - ? : ( ) . ' and spaces, and no leading space. Other account types allow up to 255 characters with no character restriction. On a DEPOSIT virtual account, ignored when structuredAddress has any field set."
          },
          "addressLine2": {
            "maxLength": 255,
            "type": "string",
            "description": "City and postcode of the underlying customer. Same length and character rules as addressLine1 on a DEPOSIT virtual account. On a DEPOSIT virtual account, ignored when structuredAddress has any field set."
          },
          "addressLine3": {
            "maxLength": 255,
            "type": "string",
            "description": "Country of the underlying customer. On a DEPOSIT virtual account this must be an uppercase ISO 3166-1 alpha-2 code: a country name, a three-letter code or a lowercase code is rejected. The rule is not enforced on other account types, but send a valid code regardless. Take care not to put a state abbreviation here, which would be read as the wrong country. On a DEPOSIT virtual account, ignored when structuredAddress has any field set."
          },
          "structuredAddress": {
            "$ref": "#/components/schemas/StructuredAddress"
          },
          "customerId": {
            "type": "string",
            "description": "Optional id of the customer this account belongs to."
          },
          "payId": {
            "type": "string",
            "description": "PayID for the account. Has no effect on provider-issued virtual accounts. Must be unique."
          }
        },
        "description": "Create bank account request. A DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are the address, with the rules described on each line. Other account types keep their existing address-line behaviour."
      },
      "CompanyModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "UserModel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          }
        }
      },
      "FeeResponse": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "description": "Fixed fee in the account currency. Null when not set."
          },
          "percentage": {
            "type": "number",
            "description": "Percentage fee. Null when not set."
          }
        },
        "description": "A fee, expressed as a fixed amount, a percentage, or neither when no fee is configured."
      }
    }
  },
  "x-amazon-apigateway-documentation": {
    "version": "docs-70fec286a283",
    "createdDate": "2026-11-12T05:59:46Z",
    "documentationParts": [
      {
        "location": {
          "type": "API"
        },
        "properties": {
          "description": "## Introduction\nThis is the document for Stablecoin Distributor Asset Service APIs in the AUDD issuing platform.\n## Mutual TLS Connection\nThe distributor APIs require mutual TLS connection. A client certificate needs to be provided when sending requests.\n"
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/assets/trustlines",
          "method": "POST"
        },
        "properties": {
          "summary": "Create a trustline",
          "description": "Creates a trustline so a wallet can hold an asset, or updates the limit on an existing one. Networks that use trustlines, such as Stellar and XRPL, require one before AUDD can be sent to the wallet.\n\nThe wallet must be ACTIVE and on the same network as the asset. Posting a limit identical to the current one returns the existing trustline unchanged.\n\nHow quickly the trustline becomes usable depends on the network. Some return status ACTIVE straight away with a null transactionId; others return PENDING or UPDATING together with a transactionId you can follow using GET /transactions/{id}. Poll GET /assets/{id}/trustlines until status is ACTIVE.",
          "tags": [
            "Asset"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/assets/{id}/trustlines",
          "method": "GET"
        },
        "properties": {
          "summary": "Query trustlines",
          "description": "Lists the wallets that hold a trustline for this asset, together with the limit each has set. Results are scoped to your own company.",
          "tags": [
            "Asset"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/assets/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get asset info by id",
          "description": "Returns one asset, including the contract address on EVM networks and the trade wallet used for mints and burns.",
          "tags": [
            "Asset"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/assets",
          "method": "GET"
        },
        "properties": {
          "summary": "Get list of assets",
          "description": "Lists the assets AUDD issues. Pass network to scope the list to the chain you are working with, which is how you find the id of the AUDD asset to mint: the assetId this returns is what POST /trades/buy and POST /trades/sell expect.\n\nRequesting a wide page can fail with a 500 when the page includes an asset that cannot be rendered, so always narrow the list with network rather than reading it unfiltered.",
          "tags": [
            "Asset"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/bulk-delete",
          "method": "POST"
        },
        "properties": {
          "summary": "Bulk delete bank accounts",
          "description": "Delete several bank accounts within the company in one request",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/deposit",
          "method": "POST"
        },
        "properties": {
          "tags": [
            "Bank Account"
          ],
          "summary": "Deposit bank account assets",
          "description": "Deposit bank account assets"
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/withdraw",
          "method": "POST"
        },
        "properties": {
          "summary": "Withdraw bank account assets",
          "description": "Moves AUD out of one of your deposit virtual accounts to a registered withdrawal account. The source must be a DEPOSIT account with enough available balance, and the destination must be a WITHDRAWAL account; anything else is rejected.\n\nProcessing is asynchronous. The call returns as soon as the record is created, normally with status IN_PROGRESS, and the record reaches DONE, FAILED, CANCELED or REFUNDED later. Poll GET /bank-accounts/{id}/balance-records on the source account to follow it.\n\nSupply idempotencyKey to make retries safe: replaying the same key with the same payload returns the original record instead of moving money twice.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET"
        },
        "properties": {
          "summary": "Get a list of balance records for a bank account",
          "description": "Returns a paginated list of deposit and withdrawal balance records for the given bank account, most recent first.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/{id}",
          "method": "DELETE"
        },
        "properties": {
          "summary": "Delete a bank account within the company",
          "description": "Removes a bank account belonging to your company, so that it no longer appears in GET /bank-accounts, can no longer be updated through PUT or PATCH, and can no longer receive a withdrawal.\n\nDeletion is permanent and cannot be undone. It does not check whether the account holds a balance, so make sure the funds have been withdrawn first. Repeating the call on an account you have already deleted is harmless and answers 204 again.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get bank account info by id",
          "description": "Returns the full record for one bank account, including the nested customer, creator and linked-account detail that GET /bank-accounts omits.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/{id}",
          "method": "PATCH"
        },
        "properties": {
          "summary": "Update bank account customer details",
          "description": "Changes the customer details recorded against a bank account and sends them to the bank provider. Use this rather than PUT /bank-accounts/{id} once an account's customer details have already been registered with the provider.\n\nOnly accounts held with a bank provider can be patched. An external account you registered yourself has no provider behind it and is rejected.\n\nSend one or two change items. Each item changes exactly one thing, chosen from the account holder's company name, the account holder's individual name (first and last together), or the address (structuredAddress, or lines 1 to 3), and each item must carry a reason that matches what it changes. Two items cannot change the same thing, so a valid pair is a name change plus an address change. Changing an individual name is only possible on an account that already holds an individual first and last name.\n\nNames and address lines follow the same rules as POST /bank-accounts: at most 35 characters, letters, digits, / - ? : ( ) . ' and spaces only, no leading space, and an uppercase ISO 3166-1 alpha-2 country code in addressLine3.\n\nAn address change carries reason COMPANY_ADDRESS_CHANGE or INDIVIDUAL_ADDRESS_CHANGE and the complete new address, either as structuredAddress or as addressLine1 to addressLine3. A structuredAddress needs the same fields as POST /bank-accounts: locality, state, postCode, countryCode and streetName. When structuredAddress has any field set, addressLine1-3 are ignored. An address change given as lines replaces any stored structuredAddress, which then reads as null.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts/{id}",
          "method": "PUT"
        },
        "properties": {
          "summary": "Update a bank account within the company",
          "description": "Replaces the editable fields of a bank account.\n\nThis is a full replace, not a partial update: every editable field is overwritten with what you send, and any field you omit is set to null. Read the account with GET /bank-accounts/{id} first and send back the complete set of values you want to keep, changing only what you intend to change. Sending only nickname will clear the account holder name and all four behaviour flags.\n\nThe address is the exception: omitted address fields leave the stored address unchanged, so omit all of them on status, nickname or flag changes, even when no address is stored. For a DEPOSIT virtual account, send an address either as structuredAddress or as addressLine1-3, with the same rules as POST /bank-accounts; when structuredAddress has any field set, addressLine1-3 are ignored. Once the account's customer details are registered with the provider, change the address with PATCH /bank-accounts/{id} instead. An unchanged echo of the stored address is not an address change. Other account types keep their existing address-line behaviour.\n\nSome fields are restricted. Changing status, nameMatchingEnabled or referenceCheckingEnabled requires additional roles most integrations do not hold. Because omitting a flag counts as changing it, an account that already has nameMatchingEnabled or referenceCheckingEnabled set cannot be updated at all without those roles unless you send the same values back. The bsb, accountNumber and payId of a deposit virtual account cannot be changed, and neither can the payment details of an automatically created remitter account.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts",
          "method": "GET"
        },
        "properties": {
          "summary": "Get a list of bank accounts",
          "description": "Returns a paginated list of the bank accounts visible to you, newest first. Accounts your company owns are included, along with any shared with you. Accounts deleted with DELETE /bank-accounts/{id} are not listed.\n\nExpect to see accounts you did not create. One is added automatically for each party that sends funds to your virtual accounts, with subType REMITTER.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/bank-accounts",
          "method": "POST"
        },
        "properties": {
          "summary": "Create a bank account",
          "description": "Creates a bank account for your company. The same endpoint creates both kinds of account used by the deposit and withdrawal flows, and subType selects which:\n\n- subType DEPOSIT, using the bankProviderType value AUDD issues you during onboarding, creates an internal virtual account that receives AUD. The provider allocates bsb, accountNumber, iban and reference, so do not send bank details yourself.\n- subType WITHDRAWAL with bankProviderType NONE records an external account that AUDD pays out to. You must supply the bank details, and should supply internalBankAccountId to link it to the virtual account holding the funds.\n\nAny other bankProviderType value belongs to a legacy integration and is not available.\n\nA DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are required as before. Other account types keep their existing address-line contract.",
          "tags": [
            "Bank Account"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/companies/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get company info by id",
          "description": "Returns one company. You can read your own company; another company's id returns 404 rather than an access error.",
          "tags": [
            "Company"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/companies",
          "method": "GET"
        },
        "properties": {
          "summary": "Get list of companies",
          "description": "Returns the companies visible to you. An ordinary integration is scoped to its own company, so this returns exactly one entry, which is a convenient way to look up your own companyId for POST /bank-accounts and POST /wallets/external.",
          "tags": [
            "Company"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/auth/token",
          "method": "POST"
        },
        "properties": {
          "summary": "Exchange API key for JWT",
          "description": "Exchange your API key for a short-lived JWT access token. Send your key in the X-API-Key header; use the returned token as a Bearer token in the Authorization header on all other /customer endpoints. An API key is valid for 90 days from the day it is issued; rotate it in the AUDD Mint Portal (Company > Merchant Security > Rotate API key) before then. The previous key stops working as soon as a new one is issued.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST"
        },
        "properties": {
          "summary": "Assign a customer to a group and tier",
          "description": "Assign a customer to a merchant group and tier. Send a unique Idempotency-Key header so the request can be safely retried.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST"
        },
        "properties": {
          "summary": "Submit customer KYC",
          "description": "Submit a customer's KYC details for verification. Returns 202 Accepted; verification is processed asynchronously. Send a unique Idempotency-Key header so the request can be safely retried.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/customers/{customerId}",
          "method": "PUT"
        },
        "properties": {
          "summary": "Update a customer",
          "description": "Replace the details of a customer under your account. The company is taken from your token, so a customer belonging to another company returns 404. Changing a field used for KYC identity (first, middle or last name, date of birth, or address) pushes the new details to the KYC provider, resets the applicant, and moves the KYC level to REVERIFICATION_REQUIRED, which discards any documents already submitted; the customer must submit them again through a new link from POST /customer/customers/{customerId}/kyc. Sending merchantGroupId moves the customer to that group and clears the current tier; omit it to edit the profile only. Requires the customer.write scope. Send a unique Idempotency-Key header so the request can be safely retried.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/customers",
          "method": "GET"
        },
        "properties": {
          "summary": "List customers",
          "description": "List the customers under your account. Supports pagination, search, sorting, and filtering by merchant group, tier, status, and KYC status.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/customers",
          "method": "POST"
        },
        "properties": {
          "summary": "Create a customer",
          "description": "Create a customer under your account. Optionally assign the customer to a merchant group on creation with merchantGroupId. Send a unique Idempotency-Key header so the request can be safely retried.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/groups/{groupId}/tiers",
          "method": "GET"
        },
        "properties": {
          "summary": "List tiers in a merchant group",
          "description": "List the tiers that belong to a merchant group.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/groups/{groupId}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get a merchant group",
          "description": "Get a single merchant group by ID.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/groups",
          "method": "GET"
        },
        "properties": {
          "summary": "List merchant groups",
          "description": "List the merchant groups available to your account. Merchant groups organise the tiers you can assign customers to. Supports pagination, search, and sorting.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/customer/tiers/{tierId}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get a tier",
          "description": "Get a single tier by ID.",
          "tags": [
            "Customer"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/login/change-password",
          "method": "POST"
        },
        "properties": {
          "summary": "Change the user's password",
          "description": "Allows a user to change their password.",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/login/jwt/refresh",
          "method": "POST"
        },
        "properties": {
          "summary": "Refresh JWT access token by refresh token",
          "description": "Exchanges a token pair for a new one. Send the current access token together with the refresh token issued alongside it. Refresh tokens are single use: each call returns a new refresh token and invalidates the one supplied, so always replace both stored values with those returned. The refresh token's 15 minute lifetime restarts on every use, so a client that refreshes at least that often stays authenticated indefinitely; leave a gap longer than 15 minutes and the user must authenticate again through POST /mfa/login. The previously issued access token stays valid until its own 5 minute expiry, so refreshing does not break requests already in flight. Unlike the other authentication endpoints this one does not check the API key, but sending it anyway is recommended for consistency.",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/login/two-factor/enable",
          "method": "POST"
        },
        "properties": {
          "summary": "Enable two-factor authentication for a user",
          "description": "Enables two-factor authentication for the specified user.",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/login/two-factor/secret",
          "method": "GET"
        },
        "properties": {
          "summary": "Generate two-factor authentication secret",
          "description": "Returns a fresh TOTP shared secret for enrolling a user in two-factor authentication. Call this once, during initial MFA setup for a user, then register the returned secretBase32Encoded value with POST /mfa/enable. Store it securely: the same secret is required to generate the TOTP code for every subsequent login, and this endpoint returns a different secret on every call. Calling it does not enrol anything or change the user.",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/login/two-factor",
          "method": "POST"
        },
        "properties": {
          "summary": "Get a new authenticated token from an OTP and twoFactorID. You must invoke the login API first to obtain the twoFactorId",
          "description": "Get a new authenticated token from an OTP and twoFactorID. You must invoke the login API first to obtain the twoFactorId",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/login",
          "method": "POST"
        },
        "properties": {
          "summary": "Get a new authenticated token or twoFactorID required for 2FA",
          "description": "Get a new authenticated token or twoFactorID required for 2FA",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/mfa/enable",
          "method": "POST"
        },
        "properties": {
          "summary": "Enable MFA",
          "description": "Registers a TOTP authenticator for a user from the shared secret returned by GET /login/two-factor/secret, and returns that user's recovery codes. This is a one-time step per user: calling it again for an enrolled user returns 409. The recovery codes are returned only by this call and cannot be retrieved later, so store them before discarding the response. Errors raised by the identity provider rather than by this endpoint are passed through with their original status and a generic body of the form {\"message\":\"Request failed with status code <n>\",\"details\":\"\"}.",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/mfa/login",
          "method": "POST"
        },
        "properties": {
          "summary": "Login with MFA",
          "description": "Authenticates a user who has completed MFA enrolment, and returns the credentials used by every other endpoint. Send the username and password issued during onboarding together with a current TOTP code generated from the secret registered via POST /mfa/enable. A user who has not enrolled receives 403 here until they do.",
          "tags": [
            "Authentication"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/networks",
          "method": "GET"
        },
        "properties": {
          "summary": "Get all networks information, including parent network and its sub networks",
          "description": "Lists the blockchain networks AUDD supports, grouped by family. Each entry has a name, which is the family label, and subNetworks, which are the values you actually send elsewhere: as the network query parameter on GET /assets, and as the network field on POST /wallets/external. Send a sub-network value such as ETHEREUM_BASE_SEPOLIA, never the family name such as BASE.\n\nA wallet and the AUDD asset you mint must be on the same sub-network, so pick one here before registering a wallet.",
          "tags": [
            "General"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/payments",
          "method": "GET"
        },
        "properties": {
          "summary": "Get payments",
          "description": "Get payments",
          "tags": [
            "Payment"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/payments",
          "method": "POST"
        },
        "properties": {
          "summary": "Sending payments from one account to a specific destination",
          "description": "Sending payments from one account to a specific destination",
          "tags": [
            "Payment"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get distributor burn wallet by asset ID",
          "description": "Returns the AUDD burn wallets for an asset, which is where you send AUDD before calling POST /trades/sell. Note that the path parameter is the ASSET id, not a wallet id.\n\nThe response carries tradeWallet, the single burn wallet resolved for the caller (unchanged from earlier versions of this API), and burnWallets, the full pool of burn wallets the caller may pay. Each entry has id, address, publicKey, network and status. The destination to send AUDD to is address on EVM networks (the 0x account; publicKey there is the raw public key, not a payable destination) and publicKey on Stellar (the G... account id; address is null on Stellar). Clients with one burn wallet get a one-entry list equal to tradeWallet.\n\nThe pool is static: repeated calls return the same list, and assigning an address to a customer and releasing it after the hold window is the client's responsibility. Cache the list, pass the chosen entry's id as tradeWalletId on POST /trades/sell, and refresh it periodically or when a sell is rejected with trade.wallet_not_eligible.",
          "tags": [
            "Trade"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/trades/buy",
          "method": "POST"
        },
        "properties": {
          "summary": "Buy assets",
          "description": "Mints AUDD to one of your registered wallets, paid for from a deposit virtual account.\n\nFour things must already exist: a DEPOSIT bank account holding cleared AUD, an ACTIVE wallet registered with POST /wallets/external, the id of the AUDD asset on that wallet's network from GET /assets, and enough available balance to cover the amount. The wallet and the asset must be on the same network.\n\nThe AUD is debited from the funding account as a WITHDRAWAL balance record, visible through GET /bank-accounts/{id}/balance-records. Minting is asynchronous: the response carries a transactionId you can follow with GET /transactions/{id}, and completion time depends on the chain.",
          "tags": [
            "Trade"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/trades/sell",
          "method": "POST"
        },
        "properties": {
          "summary": "Sell assets",
          "description": "Redeems AUDD you have already sent to the burn wallet, settling the AUD into one of your deposit virtual accounts.\n\nSend the AUDD on chain first, then call this with the resulting blockchainTxId. Retrieve the burn wallet address with GET /trades/burn-wallet/{id} beforehand. If you use a pool of burn wallets, also pass the id of the burn wallet you paid as tradeWalletId, otherwise the sell is matched against your default burn wallet only.\n\nSettlement is asynchronous and is confirmed by webhook rather than in this response: the AUD arrives as a DEPOSIT balance record carrying a tradeId that matches the trade returned here. Match on that tradeId, not on the description, to tell a burn settlement apart from an ordinary customer deposit.",
          "tags": [
            "Trade"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/trades/swap",
          "method": "POST"
        },
        "properties": {
          "tags": [
            "Trade"
          ],
          "summary": "Swap assets",
          "description": "Swap assets"
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/transactions/{id}/cancel",
          "method": "PUT"
        },
        "properties": {
          "summary": "Cancel transaction",
          "description": "Cancels a transaction that has not been submitted yet. Only a PENDING transaction can be cancelled, and only by whoever created it or by someone who can sign for its source wallet. Anything already settled, failed or cancelled is refused, as is a parent transaction that groups several others.",
          "tags": [
            "Transaction"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT"
        },
        "properties": {
          "summary": "Resubmit Transaction",
          "description": "Resubmits a transaction that FAILED, rebuilding and re-signing it where that is possible.\n\nThis only applies to wallets AUDD holds the keys for. A transaction sent from a wallet you hold yourself is refused with transaction.source_is_external, because AUDD cannot re-sign on your behalf; send the transfer again from your own infrastructure instead.",
          "tags": [
            "Transaction"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/transactions/{id}/sign",
          "method": "POST"
        },
        "properties": {
          "summary": "Sign the transaction by ID",
          "description": "Adds your signature to a PENDING transaction and submits it once the required signing weight is reached.\n\nThis only applies to multi-signature wallets AUDD manages. A wallet you hold yourself has no signers registered against it, as GET /wallets/{id}/signers will show, so signing is refused with transaction.invalid_signer.",
          "tags": [
            "Transaction"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/transactions/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get the transaction info by ID",
          "description": "Returns one transaction in full: the operations it carries, its current status, and once it settles its on-chain hash and fee. Use it to follow a transactionId through to DONE or FAILED after a mint, a burn, a trustline or a withdrawal.",
          "tags": [
            "Transaction"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/transactions",
          "method": "GET"
        },
        "properties": {
          "summary": "Get a list of transactions",
          "description": "Returns a paginated list of transactions visible to the authenticated user, most recent first.",
          "tags": [
            "Transaction"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/users/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get a user info",
          "description": "Returns one user, with more detail than the list gives, including their two-factor enrolment.",
          "tags": [
            "User"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/users",
          "method": "GET"
        },
        "properties": {
          "summary": "Get list of users",
          "description": "Returns a paginated list of the users in your company. The list is scoped to your own company automatically, so it never contains users belonging to anyone else. Deleted users are not listed.",
          "tags": [
            "User"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets/external",
          "method": "POST"
        },
        "properties": {
          "summary": "Create an external wallet",
          "description": "Registers a wallet you already control so that AUDD can mint to it or accept a burn from it. AUDD never holds the keys: you supply the address and keep custody.\n\nThe wallet and the AUDD asset you intend to mint must be on the same network, so choose the network first with GET /networks and pass one of its subNetworks values.\n\nA newly registered wallet is returned ACTIVE on networks where the address alone is enough. On networks that require the account to exist on chain it stays INACTIVE until it has a balance or some activity; fund it with a small amount of the network's native coin and call PUT /wallets/{id}/sync to re-check.",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets/friendbot",
          "method": "POST"
        },
        "properties": {
          "summary": "Create a wallet by friendbot",
          "description": "Create a wallet by friendbot",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets/{id}/signers",
          "method": "GET"
        },
        "properties": {
          "summary": "Get the signer information",
          "description": "Returns the signers registered against a wallet. A wallet you hold yourself has no signers recorded here, so this returns an empty list; it is populated for multi-signature wallets AUDD manages.",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets/{id}/sync",
          "method": "PUT"
        },
        "properties": {
          "summary": "Sync wallet by ID",
          "description": "Re-reads a registered wallet from its blockchain and updates the copy AUDD holds, then returns it. Use this after funding a wallet that was registered INACTIVE: once the chain shows a balance or activity, syncing moves it to ACTIVE. Syncing a wallet that is already ACTIVE is harmless and simply confirms it.",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets/{id}",
          "method": "GET"
        },
        "properties": {
          "summary": "Get the wallet info by ID",
          "description": "Returns one wallet in full, including its balances, signers and thresholds, which the list does not carry.",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets",
          "method": "GET"
        },
        "properties": {
          "summary": "Get list of wallets",
          "description": "Returns a paginated list of the wallets registered to your company, newest first. Both wallets you registered yourself and any AUDD holds for you appear here.",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "METHOD",
          "path": "/wallets",
          "method": "POST"
        },
        "properties": {
          "summary": "Create a wallet",
          "description": "Create a wallet",
          "tags": [
            "Wallet"
          ]
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.amount"
        },
        "properties": {
          "description": "Amount moved, in the record's currency."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.bankTransactionId"
        },
        "properties": {
          "description": "The bank provider's identifier for the payment, once one exists. Null while the movement is still being prepared."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.createdAt"
        },
        "properties": {
          "description": "When the record was created."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.currency"
        },
        "properties": {
          "description": "Currency of amount and fee."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.description"
        },
        "properties": {
          "description": "Free-text description, where one was recorded. Null otherwise."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.fee"
        },
        "properties": {
          "description": "Fee charged on this movement. Zero when no fee applies."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.holdUntilDate"
        },
        "properties": {
          "description": "When the movement is held pending review, the time the hold expires. Null when not held."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.id"
        },
        "properties": {
          "description": "Identifier of this balance record. Store it to reconcile the withdrawal later."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.reference"
        },
        "properties": {
          "description": "Payment reference for this movement. When idempotencyKey was supplied on a withdrawal, this is that key."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.refundTransactionId"
        },
        "properties": {
          "description": "Identifier of the refund, where this movement was refunded. Null otherwise."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.status"
        },
        "properties": {
          "description": "Current state. A new withdrawal is normally IN_PROGRESS. DONE, FAILED, CANCELED and REFUNDED are terminal; the rest are transient."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.transactionId"
        },
        "properties": {
          "description": "Identifier of the related on-chain transaction, where the movement is part of a mint or burn. Null otherwise."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.type"
        },
        "properties": {
          "description": "Direction of the movement."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse.updatedAt"
        },
        "properties": {
          "description": "When the record last changed. Null until it changes."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BalanceRecordResponse"
        },
        "properties": {
          "description": "A movement of funds against a bank account. Responses may also carry AUDD-internal fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.accountHolderFirstname"
        },
        "properties": {
          "description": "Account holder given name, where supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.accountHolderLastname"
        },
        "properties": {
          "description": "Account holder family name, where supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.accountHolderName"
        },
        "properties": {
          "description": "Full account holder name, where supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.accountNumber"
        },
        "properties": {
          "description": "Account number. Allocated by the provider for a DEPOSIT virtual account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.address"
        },
        "properties": {
          "description": "The account's address lines, joined with newlines. When the account has a structuredAddress, the lines are generated from it, and structuredAddress returns the address as separate fields. Note that the request takes addressLine1, addressLine2 and addressLine3 separately but the response returns a single string."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.autoBurnEnabled"
        },
        "properties": {
          "description": "Marks this account as the one that receives the AUD when a burn settles automatically, that is when AUDD reaches the burn wallet without a matching POST /trades/sell. At most one account per company carries this flag, and an automatic burn fails if none does."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.autoMintEnabled"
        },
        "properties": {
          "description": "When true, AUD credited to this account is minted to AUDD automatically once the deposit clears, with no POST /trades/buy call. If that automatic mint fails, the AUD stays credited to the account, no AUDD is issued, and the mint is not retried."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.balance"
        },
        "properties": {
          "description": "Available balance in the account currency. Note the name: the field is balance, singular."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.bsb"
        },
        "properties": {
          "description": "BSB, hyphenated. Allocated by the provider for a DEPOSIT virtual account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.createdAt"
        },
        "properties": {
          "description": "When the account was created."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.currency"
        },
        "properties": {
          "description": "Account currency."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.iban"
        },
        "properties": {
          "description": "IBAN, where the account has one. The provider allocates one for virtual accounts."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.id"
        },
        "properties": {
          "description": "The account id. Use it as bankAccountId when minting, srcBankAccountId or destBankAccountId when withdrawing, and internalBankAccountId when linking a withdrawal account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.linkedAccounts"
        },
        "properties": {
          "description": "The other accounts in the same group. For a deposit virtual account these are the accounts attached to it; for an attached account this is its virtual account together with the other accounts attached to that same one."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.nameMatchingEnabled"
        },
        "properties": {
          "description": "Whether the sender's name on an incoming deposit is checked against this account's registered holder names. The comparison is fuzzy and also tried with spaces removed. Null means the company default applies."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.nameMatchingEnabledResolved"
        },
        "properties": {
          "description": "The effective value of nameMatchingEnabled for this account once the company default has been applied. Read this rather than nameMatchingEnabled to know whether the check is actually on."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.nickname"
        },
        "properties": {
          "description": "The friendly name supplied on creation."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.payId"
        },
        "properties": {
          "description": "PayID, where set. Null unless the account's provider supports PayID."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.providerType"
        },
        "properties": {
          "description": "The bank provider backing this account: the value AUDD issued you, for a virtual account, or NONE for an external account you registered. Note the name difference between the request field bankProviderType and this response field providerType."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.reference"
        },
        "properties": {
          "description": "A payment reference allocated to this account when it was created, returned for your own reconciliation. Incoming deposits are neither matched against it nor required to quote it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.referenceCheckingEnabled"
        },
        "properties": {
          "description": "When enabled, the description on an incoming deposit is screened against a list of blocked terms; a match rejects the deposit and flags it for review rather than crediting it. Terms of three characters or fewer, and purely numeric terms, must equal the whole description, while longer terms match anywhere within it. This does not require a deposit to quote this account's reference. Null means the company default applies, and screening is on when neither is set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.referenceCheckingEnabledResolved"
        },
        "properties": {
          "description": "The effective value of referenceCheckingEnabled once the company default has been applied. Read this rather than referenceCheckingEnabled to know whether screening is actually on."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.status"
        },
        "properties": {
          "description": "Account status. Only an ACTIVE account can be used to mint or withdraw. A REMITTER account is created PENDING and becomes ACTIVE as soon as the deposit that created it clears, so in practice you will see ACTIVE; it stays PENDING only while a hold applies. Treat the list as non-exhaustive: additional statuses exist for AUDD-internal handling and may appear."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.subType"
        },
        "properties": {
          "description": "Account sub type. DEPOSIT and WITHDRAWAL are the accounts you create. REMITTER accounts are created automatically, one per party that sends funds to your virtual accounts, so expect to see accounts here that you did not create; handle this value even though you cannot send it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.swiftCode"
        },
        "properties": {
          "description": "SWIFT/BIC, for an international external account. Null otherwise."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse.type"
        },
        "properties": {
          "description": "Account type. Accounts belonging to your company are DISTRIBUTOR. Other values may appear for accounts shared with you and should be tolerated rather than relied on."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountDetailResponse"
        },
        "properties": {
          "description": "A bank account. Responses may also carry AUDD-internal fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.accountHolderFirstname"
        },
        "properties": {
          "description": "Account holder given name, where supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.accountHolderLastname"
        },
        "properties": {
          "description": "Account holder family name, where supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.accountHolderName"
        },
        "properties": {
          "description": "Full account holder name, where supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.accountNumber"
        },
        "properties": {
          "description": "Account number."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.address"
        },
        "properties": {
          "description": "The account's address lines, joined with newlines. When the account has a structuredAddress, the lines are generated from it, and structuredAddress returns the address as separate fields."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.autoBurnEnabled"
        },
        "properties": {
          "description": "Marks this account as the one that receives the AUD when a burn settles automatically, that is when AUDD reaches the burn wallet without a matching POST /trades/sell. At most one account per company carries this flag, and an automatic burn fails if none does."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.autoMintEnabled"
        },
        "properties": {
          "description": "When true, AUD credited to this account is minted to AUDD automatically once the deposit clears, with no POST /trades/buy call. If that automatic mint fails, the AUD stays credited to the account, no AUDD is issued, and the mint is not retried."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.balance"
        },
        "properties": {
          "description": "Available balance in the account currency. Note the name: the field is balance, singular."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.bsb"
        },
        "properties": {
          "description": "BSB, hyphenated."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.createdAt"
        },
        "properties": {
          "description": "When the account was created."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.currency"
        },
        "properties": {
          "description": "Account currency."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.customerPublicId"
        },
        "properties": {
          "description": "Id of the customer this account belongs to, where one was supplied."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.iban"
        },
        "properties": {
          "description": "IBAN, where the account has one."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.id"
        },
        "properties": {
          "description": "The account id. Use it as bankAccountId when minting, srcBankAccountId or destBankAccountId when withdrawing, and internalBankAccountId when linking a withdrawal account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.nameMatchingEnabled"
        },
        "properties": {
          "description": "Whether the sender's name on an incoming deposit is checked against this account's registered holder names. The comparison is fuzzy and also tried with spaces removed. Null means the company default applies."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.nickname"
        },
        "properties": {
          "description": "The friendly name given when the account was created."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.payId"
        },
        "properties": {
          "description": "PayID, where set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.providerType"
        },
        "properties": {
          "description": "The bank provider backing this account: the value AUDD issued you, for a virtual account, or NONE for an external account you registered."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.reference"
        },
        "properties": {
          "description": "A payment reference allocated to this account when it was created, returned for your own reconciliation. Incoming deposits are neither matched against it nor required to quote it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.sourceAccount"
        },
        "properties": {
          "description": "The internal account this one is attached to: for a WITHDRAWAL account the deposit virtual account passed as internalBankAccountId, and for a REMITTER account the virtual account the funds arrived into. Null when the account stands alone."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.status"
        },
        "properties": {
          "description": "Account status. Only an ACTIVE account can be used to mint or withdraw. Treat the list as non-exhaustive."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.subType"
        },
        "properties": {
          "description": "Account sub type. DEPOSIT and WITHDRAWAL are the accounts you create. REMITTER accounts are created automatically, one per party that sends funds to your virtual accounts."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.swiftCode"
        },
        "properties": {
          "description": "SWIFT/BIC, for an international external account. Null otherwise."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse.type"
        },
        "properties": {
          "description": "Account type. Accounts belonging to your company are DISTRIBUTOR. Other values may appear for accounts shared with you and should be tolerated rather than relied on."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "BankAccountOverviewResponse"
        },
        "properties": {
          "description": "A bank account as returned in a list. Carries the same fields as BankAccountDetailResponse minus the nested customer, createdBy and linkedAccounts detail. Responses may also contain AUDD-internal fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse.email"
        },
        "properties": {
          "description": "Contact email held for the company."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse.id"
        },
        "properties": {
          "description": "The company id. Send it as companyId when creating a bank account or registering a wallet."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse.name"
        },
        "properties": {
          "description": "Registered company name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse.number"
        },
        "properties": {
          "description": "Company registration number, such as an ABN or ACN, where one is recorded."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse.phoneNumber"
        },
        "properties": {
          "description": "Contact phone number held for the company."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse.types"
        },
        "properties": {
          "description": "The roles this company holds on the platform. A client integration is a DISTRIBUTOR."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyDetailResponse"
        },
        "properties": {
          "description": "One company in full. Responses may also carry additional fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse.email"
        },
        "properties": {
          "description": "Contact email held for the company."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse.id"
        },
        "properties": {
          "description": "The company id. Send it as companyId when creating a bank account or registering a wallet."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse.name"
        },
        "properties": {
          "description": "Registered company name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse.number"
        },
        "properties": {
          "description": "Company registration number, such as an ABN or ACN, where one is recorded."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse.phoneNumber"
        },
        "properties": {
          "description": "Contact phone number held for the company."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse.types"
        },
        "properties": {
          "description": "The roles this company holds on the platform. A client integration is a DISTRIBUTOR."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CompanyOverviewResponse"
        },
        "properties": {
          "description": "A company as returned in a list. Responses may also carry additional fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.accountHolderFirstname"
        },
        "properties": {
          "description": "Given name of the underlying customer. Required for a DEPOSIT virtual account, and optional otherwise. Must match the name on the bank account that will send funds, or deposits may not clear. On a DEPOSIT virtual account: at most 35 characters, only letters, digits, / - ? : ( ) . ' and spaces, no leading space, and critically the provider also caps accountHolderFirstname plus a space plus accountHolderLastname at 35 characters combined. Exceeding the combined limit passes local validation and is then rejected upstream with messageKey bank_account.invalid_customer_details."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.accountHolderLastname"
        },
        "properties": {
          "description": "Family name of the underlying customer. Required for a DEPOSIT virtual account, and optional otherwise. Same character, length and combined-name rules as accountHolderFirstname."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.accountHolderName"
        },
        "properties": {
          "description": "Full account holder name for an external account. Used as the preferred creditor name on outgoing payments; when absent, accountHolderFirstname and accountHolderLastname are used, then nickname. On a DEPOSIT virtual account it must also be at most 35 characters and use only letters, digits, / - ? : ( ) . ' and spaces, with no leading space."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.accountNumber"
        },
        "properties": {
          "description": "Account number, digits only. Do not send for a DEPOSIT virtual account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.addressLine1"
        },
        "properties": {
          "description": "Street address of the underlying customer. On a DEPOSIT virtual account: at most 35 characters, only letters, digits, / - ? : ( ) . ' and spaces, and no leading space. Other account types allow up to 255 characters with no character restriction. On a DEPOSIT virtual account, ignored when structuredAddress has any field set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.addressLine2"
        },
        "properties": {
          "description": "City and postcode of the underlying customer. Same length and character rules as addressLine1 on a DEPOSIT virtual account. On a DEPOSIT virtual account, ignored when structuredAddress has any field set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.addressLine3"
        },
        "properties": {
          "description": "Country of the underlying customer. On a DEPOSIT virtual account this must be an uppercase ISO 3166-1 alpha-2 code: a country name, a three-letter code or a lowercase code is rejected. The rule is not enforced on other account types, but send a valid code regardless. Take care not to put a state abbreviation here, which would be read as the wrong country. On a DEPOSIT virtual account, ignored when structuredAddress has any field set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.bankProviderType"
        },
        "properties": {
          "description": "Required. For a DEPOSIT virtual account, use the value AUDD issues you during onboarding; the provider then allocates the bank details. For an external WITHDRAWAL or REMITTER account whose details you supply yourself, use NONE."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.bsb"
        },
        "properties": {
          "description": "Australian BSB, including the hyphen. Mutually exclusive with swiftCode. Required, with accountNumber, for a domestic external account. Do not send for a DEPOSIT virtual account: the provider allocates it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.companyId"
        },
        "properties": {
          "description": "Your distributor company id."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.currency"
        },
        "properties": {
          "description": "Defaults to AUD when omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.customerId"
        },
        "properties": {
          "description": "Optional id of the customer this account belongs to."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.iban"
        },
        "properties": {
          "description": "IBAN for an international account, used with swiftCode."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.internalBankAccountId"
        },
        "properties": {
          "description": "For subType WITHDRAWAL, the id of the DEPOSIT virtual account this withdrawal account is linked to, so proceeds settle against the right account. Not currently enforced when bankProviderType is NONE, but supply it: the withdrawal flow depends on the link."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.nickname"
        },
        "properties": {
          "description": "A friendly name for the account. Required. Printable ASCII only."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.payId"
        },
        "properties": {
          "description": "PayID for the account. Has no effect on provider-issued virtual accounts. Must be unique."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.subType"
        },
        "properties": {
          "description": "Required. DEPOSIT creates an internal virtual account that receives AUD; WITHDRAWAL records an external account AUDD pays out to. Accounts representing the parties who send you funds are created automatically when a deposit arrives, and are not created through this endpoint."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.swiftCode"
        },
        "properties": {
          "description": "SWIFT/BIC for an international account. Mutually exclusive with bsb, and must be accompanied by iban or accountNumber."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest.type"
        },
        "properties": {
          "description": "DISTRIBUTOR, which is also the default when omitted. Other account types exist for AUDD-internal use and are not available to client integrations."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateBankAccountRequest"
        },
        "properties": {
          "description": "Create bank account request. A DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are the address, with the rules described on each line. Other account types keep their existing address-line behaviour."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest.companyId"
        },
        "properties": {
          "description": "Your distributor company id, as returned by GET /companies."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest.customerId"
        },
        "properties": {
          "description": "Optional id of the customer this wallet belongs to."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest.network"
        },
        "properties": {
          "description": "The network this wallet is on, given as one of the subNetworks values from GET /networks, for example ETHEREUM_BASE_SEPOLIA. The wallet and the AUDD asset must be on the same network."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest.nickname"
        },
        "properties": {
          "description": "A friendly name for the wallet, used to identify it in lists."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest.publicKey"
        },
        "properties": {
          "description": "The wallet address on the chosen network."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest.type"
        },
        "properties": {
          "description": "CUSTOMER when AUDD will mint directly to an end user's wallet, DISTRIBUTOR for a wallet your organisation owns and controls. Any other value is rejected with messageKey wallet.invalid_external_wallet_type."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateExternalWalletRequest"
        },
        "properties": {
          "description": "Registers a wallet you already control. AUDD stores the address only and never holds the keys."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateOrUpdateTrustlineRequest.assetId"
        },
        "properties": {
          "description": "Id of the asset the wallet should be able to hold, from GET /assets."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateOrUpdateTrustlineRequest.limit"
        },
        "properties": {
          "description": "Maximum amount of the asset the wallet is willing to hold. Up to 12 digits before the decimal point and 7 after. A new trustline must be created with a limit above zero, and the limit on an existing trustline cannot be lowered below the amount the wallet already holds."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CreateOrUpdateTrustlineRequest.sourceId"
        },
        "properties": {
          "description": "Id of the registered wallet that will hold the asset, from GET /wallets. It must be ACTIVE and on the same network as the asset."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "CustomerGatewayKycSubmissionResponse.kycStatus"
        },
        "properties": {
          "description": "Always \"PENDING\" on submission; the outcome arrives asynchronously"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "DataResponseNetworkResponse.items"
        },
        "properties": {
          "description": "The supported network families."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "DataResponseNetworkResponse.total"
        },
        "properties": {
          "description": "Number of families returned."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "FeeResponse.amount"
        },
        "properties": {
          "description": "Fixed fee in the account currency. Null when not set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "FeeResponse.percentage"
        },
        "properties": {
          "description": "Percentage fee. Null when not set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "FeeResponse"
        },
        "properties": {
          "description": "A fee, expressed as a fixed amount, a percentage, or neither when no fee is configured."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "JWTRefreshRequest.accessToken"
        },
        "properties": {
          "description": "The current access token, exactly as returned by POST /mfa/login or by a previous call to this endpoint. Do not modify or attempt to decode it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "JWTRefreshRequest.refreshToken"
        },
        "properties": {
          "description": "The refresh token issued alongside that access token. Single use: once exchanged it is invalid and reusing it returns 400."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "JWTRefreshResponse.refreshToken"
        },
        "properties": {
          "description": "A new refresh token, replacing the one supplied, which is now invalid. Store it in place of the old value."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "JWTRefreshResponse.refreshTokenId"
        },
        "properties": {
          "description": "Identifier for the newly issued refresh token. Not required by any endpoint in this API."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "JWTRefreshResponse.token"
        },
        "properties": {
          "description": "A new access token, replacing the one supplied. Send it as \"Authorization: Bearer <token>\". Opaque and undecodable, as with POST /mfa/login, and valid for 5 minutes. Note that this response carries no expiry field, so track the 5 minutes from the time of this call."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginRequest.mfaCode"
        },
        "properties": {
          "description": "A current 6-digit TOTP code generated from the secret registered via POST /mfa/enable."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginRequest.password"
        },
        "properties": {
          "description": "The password issued to the user by AUDD during onboarding. Users cannot change their own password."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginRequest.username"
        },
        "properties": {
          "description": "The username issued to the user by AUDD during onboarding."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginResponse.refreshToken"
        },
        "properties": {
          "description": "Opaque encrypted refresh credential. Send it together with the current token to POST /login/jwt/refresh to obtain a new pair."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginResponse.refreshTokenId"
        },
        "properties": {
          "description": "Identifier for the issued refresh token. Not required by any endpoint in this API."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginResponse.token"
        },
        "properties": {
          "description": "The access credential for every other endpoint. Send it as \"Authorization: Bearer <token>\". Despite the name it is not a JWT: it is an opaque encrypted string with no readable claims, and cannot be decoded to find its expiry. Its length varies with how many roles the user holds (2,832 to 4,104 characters observed), so do not size storage for a fixed length. Valid for 5 minutes."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginResponse.tokenExpirationInstant"
        },
        "properties": {
          "description": "When token expires, in milliseconds since the Unix epoch. Because the token cannot be decoded, this is the only way to know its expiry. Typically 5 minutes after issue."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginResponse.trustToken"
        },
        "properties": {
          "description": "Passed through from the identity provider and not used by this API. Not part of the stable contract; do not depend on it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFALoginResponse.user"
        },
        "properties": {
          "description": "The authenticated user's record, passed through from the identity provider verbatim. Its fields are not part of the stable contract and may change without notice. Do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFASetupRequest.mfaCode"
        },
        "properties": {
          "description": "A current 6-digit TOTP code generated from mfaSecretB32, proving the authenticator is working before enrolment completes."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFASetupRequest.mfaSecretB32"
        },
        "properties": {
          "description": "The secretBase32Encoded value from GET /login/two-factor/secret. Base32 only: uppercase A-Z and digits 2-7, at least 16 characters. The raw secret field from that response is not Base32 and is rejected with 400."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFASetupRequest.password"
        },
        "properties": {
          "description": "The password issued to the user by AUDD during onboarding. Users cannot change their own password."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFASetupRequest.username"
        },
        "properties": {
          "description": "The username issued to the user by AUDD during onboarding."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MFASetupResponse.recoveryCodes"
        },
        "properties": {
          "description": "Ten single-use recovery codes, each formatted XXXXX-XXXXX. Each can be used in place of a TOTP code when logging in through the portal or the API. Returned only by this call and not retrievable afterwards."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MODEL756cd6.companyBusinessName"
        },
        "properties": {
          "description": "Required when companyType is PRIVATE_COMPANY, PUBLIC_COMPANY, or TRUST."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MODEL756cd6.merchantGroupId"
        },
        "properties": {
          "description": "Optional. Defaults to your company's active default merchant group when omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MODEL756cd6.registrationNumber"
        },
        "properties": {
          "description": "Required for every companyType except INDIVIDUAL."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MODELf77ed8.companyBusinessName"
        },
        "properties": {
          "description": "Required when companyType is PRIVATE_COMPANY, PUBLIC_COMPANY, or TRUST."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MODELf77ed8.merchantGroupId"
        },
        "properties": {
          "description": "Optional. Moves the customer to this merchant group and clears the current tier. The customer stays in its current group when omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MODELf77ed8.registrationNumber"
        },
        "properties": {
          "description": "Required for every companyType except INDIVIDUAL."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MerchantGatewayTokenResponse.accessToken"
        },
        "properties": {
          "description": "Signed JWT to send as a Bearer token in the Authorization header on all other /customer endpoints"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MerchantGatewayTokenResponse.expiresIn"
        },
        "properties": {
          "description": "Token lifetime in seconds"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MerchantGatewayTokenResponse.scope"
        },
        "properties": {
          "description": "Space-delimited scopes granted to the token"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "MerchantGatewayTokenResponse.tokenType"
        },
        "properties": {
          "description": "Always \"Bearer\""
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "NetworkResponse.name"
        },
        "properties": {
          "description": "The family label. This is a grouping only and is not accepted as a value by other endpoints."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "NetworkResponse.subNetworks"
        },
        "properties": {
          "description": "The values other endpoints accept, such as the network query parameter on GET /assets and the network field on POST /wallets/external."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "NetworkResponse"
        },
        "properties": {
          "description": "A family of blockchain networks and the specific networks within it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.accountHolderCompanyName"
        },
        "properties": {
          "description": "New company name for the account holder, at most 35 characters. Use with reason COMPANY_NAME_CHANGE or COMPANY_OWNERSHIP_CHANGE."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.accountHolderFirstName"
        },
        "properties": {
          "description": "New given name for the account holder, at most 35 characters. Must be sent together with accountHolderLastName, and only works on an account that already holds an individual first and last name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.accountHolderLastName"
        },
        "properties": {
          "description": "New family name for the account holder, at most 35 characters. Must be sent together with accountHolderFirstName."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.addressLine1"
        },
        "properties": {
          "description": "New street address, at most 35 characters. Ignored when structuredAddress has any field set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.addressLine2"
        },
        "properties": {
          "description": "New city and postcode, at most 35 characters. Ignored when structuredAddress has any field set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.addressLine3"
        },
        "properties": {
          "description": "New country as an uppercase ISO 3166-1 alpha-2 code. Ignored when structuredAddress has any field set."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange.reason"
        },
        "properties": {
          "description": "Required. Why the detail is changing. It must match the category being changed: COMPANY_NAME_CHANGE or COMPANY_OWNERSHIP_CHANGE for a company name, INDIVIDUAL_NAME_CHANGE for an individual name, and COMPANY_ADDRESS_CHANGE or INDIVIDUAL_ADDRESS_CHANGE for an address. A mismatch is rejected."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsChange"
        },
        "properties": {
          "description": "A single customer-detail change. Populate exactly one category: accountHolderCompanyName, or accountHolderFirstName together with accountHolderLastName, or the address, as structuredAddress or as addressLine1 to addressLine3. Populating none or more than one is rejected. Note the capitalisation: these are accountHolderFirstName and accountHolderLastName here, while POST /bank-accounts uses accountHolderFirstname and accountHolderLastname. Address changes use {reason: COMPANY_ADDRESS_CHANGE or INDIVIDUAL_ADDRESS_CHANGE} with the complete new address. When structuredAddress has any field set it is the address change and must include locality, state, postCode, countryCode and streetName; addressLine1-3 beside it are ignored. An address change given as lines replaces any stored structuredAddress, which then reads as null."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "PatchBankAccountCustomerDetailsRequest.changes"
        },
        "properties": {
          "description": "One or two changes to apply. Each item changes exactly one category, and no two items may change the same category, so the only valid pair is one name change together with one address change."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.assetAmount"
        },
        "properties": {
          "description": "Amount of AUDD to burn, which must equal the amount sent on chain. Must be at least 1, and carry no more decimal places than the currency's minor unit allows, which is 2 for AUD. A finer amount is rejected with trade.invalid_asset_decimal_places."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.assetId"
        },
        "properties": {
          "description": "Id of the AUDD asset on the wallet's network, from GET /assets?network=. An id that does not resolve is rejected with trade.asset_not_found."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.bankAccountId"
        },
        "properties": {
          "description": "Id of the deposit virtual account the redeemed AUD settles into."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.blockchainTxId"
        },
        "properties": {
          "description": "The transaction hash or id of the on-chain transfer that moved the AUDD to the burn wallet. Required whenever verifyExternalPaymentAmount is true, which is the default, so in practice every burn from a wallet you hold yourself must supply it. Omitting it is rejected with trade.blockchain_transaction_id_required. A hash already attached to a pending or completed sell is rejected with trade.blockchain_transaction_id_already_used."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.currency"
        },
        "properties": {
          "description": "Currency of the trade. It must match the currency of the bank account, and a mismatch is rejected with bank_account.invalid_currency."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.tradeWalletId"
        },
        "properties": {
          "description": "Optional. Id of the burn wallet the AUDD was sent to, taken from burnWallets[].id on GET /trades/burn-wallet/{id}. Use it when your company has more than one burn wallet. It must be one of the burn wallets eligible for walletId and assetId, otherwise the sell is rejected with trade.wallet_not_eligible. When omitted the sell is matched against your default burn wallet, exactly as before this field existed."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.verifyExternalPaymentAmount"
        },
        "properties": {
          "description": "Whether the amount observed on chain is checked against assetAmount."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SellTradeRequest.walletId"
        },
        "properties": {
          "description": "Id of the registered wallet that sent the AUDD to the burn wallet."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "SignerResponse.status"
        },
        "properties": {
          "description": "State of this signer."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.buildingName"
        },
        "properties": {
          "description": "Building name (ISO 20022 BuildingName)."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.buildingNumber"
        },
        "properties": {
          "description": "Street number (ISO 20022 BuildingNumber), e.g. \"91\", \"12-18\" or \"91A\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.countryCode"
        },
        "properties": {
          "description": "ISO 3166-1 alpha-2 country code, e.g. \"AU\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.level"
        },
        "properties": {
          "description": "Floor or level (ISO 20022 Floor), e.g. \"30\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.locality"
        },
        "properties": {
          "description": "Suburb or town (ISO 20022 TownName), e.g. \"Adelaide\". Use the suburb or town, not the metropolitan city."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.postCode"
        },
        "properties": {
          "description": "Postcode (ISO 20022 PostCode), e.g. \"5000\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.state"
        },
        "properties": {
          "description": "State or territory (ISO 20022 CountrySubDivision), e.g. \"SA\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.streetName"
        },
        "properties": {
          "description": "Street name including the street type (ISO 20022 StreetName), e.g. \"King William Street\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress.unit"
        },
        "properties": {
          "description": "Unit, suite or flat (ISO 20022 Room), e.g. \"4\"."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "StructuredAddress"
        },
        "properties": {
          "description": "Structured postal address. Which fields are required depends on the request (see the referencing schema); on a DEPOSIT virtual account, a structuredAddress with any field set requires locality, state, postCode, countryCode and streetName (a building name or number alone is not enough). Together, unit, level, buildingName, buildingNumber, streetName, state and postCode must also fit two lines of at most 70 characters without splitting a word; a longer address is rejected with \"Structured address is too long. Shorten it, for example by abbreviating the street type\". On a DEPOSIT virtual account every field must match ^[a-zA-Z0-9/\\-?:().' +]+$ (no commas or ampersands) and must not start with whitespace, and PO Box addresses are rejected. In bank account responses structuredAddress is null when no structured address is stored for the account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.balanceRecordId"
        },
        "properties": {
          "description": "Identifier of the balance record this trade created against the bank account. A BUY appears there as a WITHDRAWAL; follow it with GET /bank-accounts/{id}/balance-records."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.currency"
        },
        "properties": {
          "description": "Currency of totalPrice."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.id"
        },
        "properties": {
          "description": "The trade id. Store it: a burn settlement is matched back to this trade by its tradeId on the incoming deposit."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.payment"
        },
        "properties": {
          "description": "The underlying asset movement, carrying its own id along with the source and destination wallets."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.totalPrice"
        },
        "properties": {
          "description": "Amount of currency moved for this trade: debited from the funding account on a BUY, settled into it on a SELL."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.transactionId"
        },
        "properties": {
          "description": "Identifier of the on-chain transaction. Follow it with GET /transactions/{id} to see whether it reached DONE or FAILED."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse.type"
        },
        "properties": {
          "description": "BUY for a mint, SELL for a burn."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeDetailResponse"
        },
        "properties": {
          "description": "A mint or burn. Responses may also carry AUDD-internal fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeRequest.assetAmount"
        },
        "properties": {
          "description": "Amount of AUDD to mint. Must be at least 1, and carry no more decimal places than the currency's minor unit allows, which is 2 for AUD. A finer amount is rejected with trade.invalid_asset_decimal_places."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeRequest.assetId"
        },
        "properties": {
          "description": "Id of the AUDD asset on the wallet's network, from GET /assets?network=. An id that does not resolve is rejected with trade.asset_not_found."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeRequest.bankAccountId"
        },
        "properties": {
          "description": "Id of the deposit virtual account holding the cleared AUD that funds the mint."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeRequest.currency"
        },
        "properties": {
          "description": "Currency of the trade. It must match the currency of the bank account, and a mismatch is rejected with bank_account.invalid_currency."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeRequest.memo"
        },
        "properties": {
          "description": "Optional note carried with the mint, where the network supports one."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TradeRequest.walletId"
        },
        "properties": {
          "description": "Id of the registered wallet that receives the minted AUDD. Must be ACTIVE and on the same network as the asset."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.dateCreated"
        },
        "properties": {
          "description": "When AUDD created the transaction, which is not when the network settled it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.description"
        },
        "properties": {
          "description": "Short label for what the transaction does, for example Swap or Payment."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.failureReason"
        },
        "properties": {
          "description": "Why the transaction failed, when status is FAILED. Null otherwise."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.feeCharged"
        },
        "properties": {
          "description": "Network fee actually charged, in the unit given by feeUnit. Populated once the transaction settles."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.feeUnit"
        },
        "properties": {
          "description": "The unit feeCharged and maxFee are expressed in, which depends on the network."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.hash"
        },
        "properties": {
          "description": "The on-chain transaction hash, once the network has accepted it. Null while the transaction is still pending."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.ledger"
        },
        "properties": {
          "description": "The ledger or block the transaction settled in, where the network exposes one."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.maxFee"
        },
        "properties": {
          "description": "Ceiling that was set for the network fee, in the unit given by feeUnit."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.operations"
        },
        "properties": {
          "description": "The individual steps the transaction performs. Their shape varies with the operation type."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.sequenceNumber"
        },
        "properties": {
          "description": "The source account's sequence or nonce for this transaction, where the network uses one."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse.signers"
        },
        "properties": {
          "description": "Signatures collected so far. Empty for a wallet you hold yourself, since AUDD holds no keys for it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionDetailResponse"
        },
        "properties": {
          "description": "One transaction in full. The response carries further fields beyond those listed here; treat them as internal and do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionOverviewResponse.canCancel"
        },
        "properties": {
          "description": "Whether you are entitled to cancel this transaction, based on who created it and whether you can sign for it. It does not take the current status into account, so it can be true for a transaction that PUT /transactions/{id}/cancel then refuses; only a PENDING transaction that does not group others can actually be cancelled."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TransactionOverviewResponse.canSign"
        },
        "properties": {
          "description": "Whether you are a signer on the source wallet. False for a wallet you hold yourself, since AUDD holds no keys for it."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TrustlineOverviewResponse.dateCreated"
        },
        "properties": {
          "description": "When the trustline was created."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TrustlineOverviewResponse.limit"
        },
        "properties": {
          "description": "Maximum amount of the asset this wallet is willing to hold."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TrustlineOverviewResponse.status"
        },
        "properties": {
          "description": "ACTIVE means the wallet can hold the asset. PENDING and UPDATING mean the change is still being submitted to the network. FAILED means it did not complete."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TwoFactorMethodModel.id"
        },
        "properties": {
          "description": "Identifier of the registered method."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TwoFactorMethodModel.lastUsed"
        },
        "properties": {
          "description": "Whether this was the method used at the most recent successful login."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TwoFactorMethodModel.method"
        },
        "properties": {
          "description": "How the second factor is delivered. Enrolment through POST /mfa/enable registers an authenticator app."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TwoFactorMethodModel"
        },
        "properties": {
          "description": "A registered two-factor method."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TwoFactorSecretResponse.secret"
        },
        "properties": {
          "description": "The shared secret in raw form. Not used for TOTP enrolment; use secretBase32Encoded instead."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "TwoFactorSecretResponse.secretBase32Encoded"
        },
        "properties": {
          "description": "The shared secret, Base32-encoded. Send this value as mfaSecretB32 to POST /mfa/enable, and use it to seed an authenticator app or TOTP library."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.accountHolderFirstname"
        },
        "properties": {
          "description": "Account holder given name. Cleared if omitted. On a deposit virtual account the customer-detail rules from POST /bank-accounts apply."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.accountHolderLastname"
        },
        "properties": {
          "description": "Account holder family name. Cleared if omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.accountHolderName"
        },
        "properties": {
          "description": "Full account holder name. Cleared if omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.accountNumber"
        },
        "properties": {
          "description": "Account number, digits only. Cannot be changed on a deposit virtual account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.addressLine1"
        },
        "properties": {
          "description": "Street address. Omitting all three lines leaves the stored address unchanged. On a DEPOSIT virtual account, ignored when structuredAddress has any field set, otherwise the address-line rules of POST /bank-accounts apply."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.addressLine2"
        },
        "properties": {
          "description": "City and postcode. Omitting all three lines leaves the stored address unchanged. On a DEPOSIT virtual account, ignored when structuredAddress has any field set, otherwise the address-line rules of POST /bank-accounts apply."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.addressLine3"
        },
        "properties": {
          "description": "Country as an ISO 3166-1 alpha-2 code, uppercase. Omitting all three lines leaves the stored address unchanged. On a DEPOSIT virtual account, ignored when structuredAddress has any field set, otherwise the address-line rules of POST /bank-accounts apply."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.autoBurnEnabled"
        },
        "properties": {
          "description": "Whether this account receives the AUD when a burn settles automatically. Cleared if omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.autoMintEnabled"
        },
        "properties": {
          "description": "Whether a cleared deposit into this account mints automatically. Cleared if omitted."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.bsb"
        },
        "properties": {
          "description": "Australian BSB, hyphenated. Mutually exclusive with swiftCode. Cannot be changed on a deposit virtual account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.iban"
        },
        "properties": {
          "description": "IBAN for an international account, used with swiftCode."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.nameMatchingEnabled"
        },
        "properties": {
          "description": "Whether an incoming deposit's sender name is checked against the registered holder names. Changing this requires the compliance role, and omitting it when it is currently set counts as a change."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.nickname"
        },
        "properties": {
          "description": "Friendly name for the account. Required on every update, even one that changes nothing else, because this endpoint replaces rather than patches."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.payId"
        },
        "properties": {
          "description": "PayID for the account. Must be unique. Cannot be changed on a deposit virtual account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.referenceCheckingEnabled"
        },
        "properties": {
          "description": "Whether an incoming deposit's description is screened against the blocked-term list. Changing this requires the compliance role, and omitting it when it is currently set counts as a change."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.status"
        },
        "properties": {
          "description": "Account status. Changing it requires a role most integrations do not hold; a change without it is rejected. Suspending a deposit account also stops it accepting deposits."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest.swiftCode"
        },
        "properties": {
          "description": "SWIFT/BIC for an international account. Mutually exclusive with bsb. Setting it clears bsb."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UpdateBankAccountRequest"
        },
        "properties": {
          "description": "Full replacement of a bank account's editable fields. Every field you omit is set to null, except the address: omitted address fields leave the stored address unchanged. A DEPOSIT virtual account takes an address either as structuredAddress or as addressLine1-3, with the same rules as POST /bank-accounts: when structuredAddress has any field set it is the address and addressLine1-3 are ignored. Omit all address fields for status, nickname or flag changes, including on accounts with no address. An unchanged echo of the stored address is not an address change. Other account types keep their existing address-line behaviour."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.email"
        },
        "properties": {
          "description": "The user's email address, which is also the username they authenticate with."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.firstName"
        },
        "properties": {
          "description": "The user's given name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.id"
        },
        "properties": {
          "description": "The user id."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.lastName"
        },
        "properties": {
          "description": "The user's family name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.phoneNumber"
        },
        "properties": {
          "description": "The user's phone number, where one is recorded."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.twoFactorEnabled"
        },
        "properties": {
          "description": "Whether the user has completed two-factor enrolment. A user with this false cannot obtain a token from POST /mfa/login and must enrol first."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse.twoFactorMethods"
        },
        "properties": {
          "description": "The two-factor methods registered for this user. Empty until the user completes POST /mfa/enable."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserDetailResponse"
        },
        "properties": {
          "description": "One user in full. Responses may also carry additional fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserOverviewResponse.email"
        },
        "properties": {
          "description": "The user's email address, which is also the username they authenticate with."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserOverviewResponse.firstName"
        },
        "properties": {
          "description": "The user's given name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserOverviewResponse.id"
        },
        "properties": {
          "description": "The user id. Pass it to GET /users/{id} for the fuller record."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserOverviewResponse.lastName"
        },
        "properties": {
          "description": "The user's family name."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserOverviewResponse.phoneNumber"
        },
        "properties": {
          "description": "The user's phone number, where one is recorded."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "UserOverviewResponse"
        },
        "properties": {
          "description": "A user as returned in a list. Responses may also carry additional fields not listed here; do not depend on them."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationError.field"
        },
        "properties": {
          "description": "Name of the request field that failed validation"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationError.message"
        },
        "properties": {
          "description": "Human-readable description of the failure"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationError.messageKey"
        },
        "properties": {
          "description": "Machine-readable key for the failed constraint"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationErrorResponse.errors"
        },
        "properties": {
          "description": "One entry per field that failed validation; present only for field-level validation failures"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationErrorResponse.message"
        },
        "properties": {
          "description": "Top-level summary message"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationErrorResponse.messageKey"
        },
        "properties": {
          "description": "Key of the first field error, retained for backward compatibility"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "ValidationErrorResponse.status"
        },
        "properties": {
          "description": "HTTP status name, e.g. BAD_REQUEST"
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletDetailResponse.custody"
        },
        "properties": {
          "description": "EXTERNAL for a wallet you registered and control, INTERNAL for one AUDD holds on your behalf."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletDetailResponse.network"
        },
        "properties": {
          "description": "The network this wallet is on, given as one of the subNetworks values from GET /networks, for example ETHEREUM_BASE_SEPOLIA. The wallet and the AUDD asset must be on the same network."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletDetailResponse.status"
        },
        "properties": {
          "description": "Wallet status. Only an ACTIVE wallet can be used to mint or burn. A wallet registered on a network that requires on-chain activity stays INACTIVE until it has some; fund it and call PUT /wallets/{id}/sync."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletDetailResponse.type"
        },
        "properties": {
          "description": "Wallet type. CUSTOMER for an end user's wallet and DISTRIBUTOR for one your organisation controls. Treat the list as non-exhaustive."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletModel.address"
        },
        "properties": {
          "description": "The derived on-chain address, for example the 0x account on EVM networks. Null on Stellar, where publicKey is the account address."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletModel.network"
        },
        "properties": {
          "description": "The network this wallet is on, given as one of the subNetworks values from GET /networks, for example ETHEREUM_BASE_SEPOLIA. The wallet and the AUDD asset must be on the same network."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletModel.publicKey"
        },
        "properties": {
          "description": "The wallet's public key. On Stellar this is the account id (G...) and is the address to pay. On EVM networks it is the raw public key and is not a payable destination; use address instead."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletModel.status"
        },
        "properties": {
          "description": "Wallet status. Only an ACTIVE wallet can be used to mint or burn. A wallet registered on a network that requires on-chain activity stays INACTIVE until it has some; fund it and call PUT /wallets/{id}/sync."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletOverviewResponse.custody"
        },
        "properties": {
          "description": "EXTERNAL for a wallet you registered and control, INTERNAL for one AUDD holds on your behalf."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletOverviewResponse.network"
        },
        "properties": {
          "description": "The network this wallet is on, given as one of the subNetworks values from GET /networks, for example ETHEREUM_BASE_SEPOLIA. The wallet and the AUDD asset must be on the same network."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletOverviewResponse.status"
        },
        "properties": {
          "description": "Wallet status. Only an ACTIVE wallet can be used to mint or burn. A wallet registered on a network that requires on-chain activity stays INACTIVE until it has some; fund it and call PUT /wallets/{id}/sync."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WalletOverviewResponse.type"
        },
        "properties": {
          "description": "Wallet type. CUSTOMER for an end user's wallet and DISTRIBUTOR for one your organisation controls. Treat the list as non-exhaustive."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WithdrawRequestModel.amount"
        },
        "properties": {
          "description": "Amount of AUD to withdraw. At least 0.01, and at most two decimal places. When includeFee is true this is the total debited from the source account rather than what the beneficiary receives."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WithdrawRequestModel.currency"
        },
        "properties": {
          "description": "Must match the currency of both accounts."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WithdrawRequestModel.destBankAccountId"
        },
        "properties": {
          "description": "Id of the registered withdrawal account to pay out to. Must be a WITHDRAWAL account."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WithdrawRequestModel.idempotencyKey"
        },
        "properties": {
          "description": "Optional key that makes retries safe. Replaying it with the same payload returns the original record without moving money again; reusing it with a different payload returns 409. The value is stored as the record's reference and comes back in the response."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WithdrawRequestModel.includeFee"
        },
        "properties": {
          "description": "When false, the default, the withdrawal fee is charged on top of amount. When true the fee is taken out of amount instead, so the beneficiary receives amount minus the fee; if that leaves nothing, the request is rejected."
        }
      },
      {
        "location": {
          "type": "MODEL",
          "name": "WithdrawRequestModel.srcBankAccountId"
        },
        "properties": {
          "description": "Id of the deposit virtual account holding the funds. Must be one of your DEPOSIT accounts. An id that does not resolve returns a 500."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "name": "customerId"
        },
        "properties": {
          "description": "Public id of the customer to update."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The asset id, from GET /assets."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "Public id of the bank account whose balance records are returned."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/bank-accounts/{id}",
          "method": "DELETE",
          "name": "id"
        },
        "properties": {
          "description": "The account id, as returned by POST /bank-accounts or GET /bank-accounts."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The account id, as returned in the id field by POST /bank-accounts or GET /bank-accounts. An id that does not exist, and a value that is not an id at all, both return 404."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "name": "id"
        },
        "properties": {
          "description": "The account id. An id that does not exist, and a value that is not an id, both return 404."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "name": "id"
        },
        "properties": {
          "description": "The account id. An id that does not exist, a value that is not an id, and a deleted account all return 404."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/companies/{id}",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The company id, as returned in the id field by GET /companies."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The id of the AUDD asset being burned, from GET /assets."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "name": "id"
        },
        "properties": {
          "description": "The transaction id, as returned in transactionId by the call that created it, such as POST /trades/buy, POST /trades/sell, POST /assets/trustlines or POST /bank-accounts/withdraw, or in id by GET /transactions. A value that is not a well-formed id is reported as not found rather than rejected."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "name": "id"
        },
        "properties": {
          "description": "The transaction id, as returned in transactionId by the call that created it, such as POST /trades/buy, POST /trades/sell, POST /assets/trustlines or POST /bank-accounts/withdraw, or in id by GET /transactions. A value that is not a well-formed id is reported as not found rather than rejected."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "name": "id"
        },
        "properties": {
          "description": "The transaction id, as returned in transactionId by the call that created it, such as POST /trades/buy, POST /trades/sell, POST /assets/trustlines or POST /bank-accounts/withdraw, or in id by GET /transactions. A value that is not a well-formed id is reported as not found rather than rejected."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/transactions/{id}",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The transaction id, as returned in transactionId by the call that created it, such as POST /trades/buy, POST /trades/sell, POST /assets/trustlines or POST /bank-accounts/withdraw, or in id by GET /transactions. A value that is not a well-formed id is reported as not found rather than rejected."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/users/{id}",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The user id, as returned in the id field by GET /users."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/wallets/{id}/signers",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The wallet id, as returned in the id field by GET /wallets."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "name": "id"
        },
        "properties": {
          "description": "The wallet id, as returned in the id field by POST /wallets/external or GET /wallets."
        }
      },
      {
        "location": {
          "type": "PATH_PARAMETER",
          "path": "/wallets/{id}",
          "method": "GET",
          "name": "id"
        },
        "properties": {
          "description": "The wallet id, as returned in the id field by POST /wallets/external or GET /wallets."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "companyId"
        },
        "properties": {
          "description": "Reserved for internal use. Results are scoped to your own company regardless of the value sent."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "companyId"
        },
        "properties": {
          "description": "Return only wallets belonging to this company. An ordinary integration is already scoped to its own company, so supplying another company's id has no effect."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction. Any other value is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction. Any other value is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction. Any other value is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/companies",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction. Any other value is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/transactions",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Accepted for consistency with other list endpoints but has no effect here: transactions are always returned newest first. A value other than ASC or DESC is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/users",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction. Any other value is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "direction"
        },
        "properties": {
          "description": "Sort direction. Any other value is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "dstAccountId"
        },
        "properties": {
          "description": "Return only records whose destination bank account matches this bank account id."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/companies",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/transactions",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/users",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "index"
        },
        "properties": {
          "description": "Zero-based index of the page to return."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "issuerId"
        },
        "properties": {
          "description": "Return only assets issued by this company."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/customer/customers",
          "method": "GET",
          "name": "kycStatus"
        },
        "properties": {
          "description": "Filter by KYC status. Any other value returns 400. Filter only; the KYC status is not part of the customer response."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. A value below 1 is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. No maximum is enforced. Values below 1 are rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. A value below 1 is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/companies",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. A value below 1 is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/transactions",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. No maximum is enforced, but large pages are slow: 250 items takes roughly 6 seconds and 1000 exceeds the 29 second gateway timeout. Values below 1 are rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/users",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. A value below 1 is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "limit"
        },
        "properties": {
          "description": "Number of items returned per page. A value below 1 is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "network"
        },
        "properties": {
          "description": "Return only assets on this network, given as one of the subNetworks values from GET /networks, for example ETHEREUM_BASE_SEPOLIA. Strongly recommended: an unfiltered list can fail with a 500. A value outside the allowed set is rejected."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search keyword."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search keyword, matched against the asset code and description."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search across record id, description, reference, bank transaction id, transaction id, source and destination account id and account number, currency, and distributor company name."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search, case-insensitive and matching anywhere in the value. Covers the account id, bsb, accountNumber, swiftCode, iban, payId, reference, currency and nickname, the owning company's id and name, and accountHolderName, accountHolderFirstname and accountHolderLastname. An empty value matches everything."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/companies",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search, case-insensitive and matching anywhere in the value. Covers the company name, email, phone number and ID. An empty value matches everything."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/transactions",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search across transaction description, source wallet nickname, status, transaction id, and the creating user's name or email."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/users",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search, case-insensitive and matching anywhere in the value. Covers the user's email, first name, last name, id and phone number, and the name of the company they belong to. An empty value matches everything."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "query"
        },
        "properties": {
          "description": "Free-text search, case-insensitive and matching anywhere in the value. Covers the wallet nickname and public key."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by, given as the underlying record's field name, for example dateCreated. A name that does not exist on the record is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by, given as the underlying record's field name, for example dateCreated or code."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by. Sort keys are the underlying field names and differ from some response field names: use dateCreated (not createdAt), dateUpdated (not updatedAt), publicId (not id), holdUntilTimestamp (not holdUntilDate) and isAdjustment (not adjustment). Records with equal sort values have no defined secondary order, so page on dateCreated when stable paging matters."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by, given as the underlying record's field name rather than the response field name. Verified values: dateCreated, nickname, status, subType. Note the mismatch: the creation timestamp is returned as createdAt but must be sorted as dateCreated, and sorting by createdAt is rejected. An unrecognised field is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/companies",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by, given as the underlying record's field name, for example dateCreated or name. An unrecognised field is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/transactions",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by. Only dateCreated and id are supported on this endpoint."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/users",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by, given as the underlying record's field name, for example email or dateCreated. An unrecognised field is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "sortBy"
        },
        "properties": {
          "description": "Attribute to sort by, given as the underlying record's field name, for example dateCreated or nickname. An unrecognised field is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "srcAccountId"
        },
        "properties": {
          "description": "Return only records whose source bank account matches this bank account id."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/customer/customers",
          "method": "GET",
          "name": "status"
        },
        "properties": {
          "description": "Filter by customer status. Any other value returns 400."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "status"
        },
        "properties": {
          "description": "Return only wallets in this state."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/assets",
          "method": "GET",
          "name": "trustorId"
        },
        "properties": {
          "description": "Return only assets the given wallet holds a trustline for. Applies to networks that use trustlines."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "type"
        },
        "properties": {
          "description": "Filter by record type. Case-sensitive: send uppercase. Omit to return both types."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/wallets",
          "method": "GET",
          "name": "type"
        },
        "properties": {
          "description": "Return only wallets of this type."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "name": "verifyExternalPaymentAmount"
        },
        "properties": {
          "description": "Whether the amount sent on chain is checked against the burn request. Defaults to true."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "name": "walletId"
        },
        "properties": {
          "description": "Optional. The id of your registered wallet that will send the AUDD. When supplied, burnWallets includes any burn wallet mapped specifically to that wallet as well as those mapped to your company. When omitted, the pool is resolved from your company alone and tradeWallet is its first entry; every entry is accepted for a sell from any of your wallets."
        }
      },
      {
        "location": {
          "type": "QUERY_PARAMETER",
          "path": "/transactions",
          "method": "GET",
          "name": "walletId"
        },
        "properties": {
          "description": "Return only transactions whose source wallet, or whose payment operation source or destination wallet, matches this wallet id."
        }
      },
      {
        "location": {
          "type": "REQUEST_BODY",
          "path": "/bank-accounts/{id}",
          "method": "PUT"
        },
        "properties": {
          "description": "Full replacement of a bank account's editable fields. Every field you omit is set to null, except the address: omitted address fields leave the stored address unchanged. A DEPOSIT virtual account takes an address either as structuredAddress or as addressLine1-3, with the same rules as POST /bank-accounts: when structuredAddress has any field set it is the address and addressLine1-3 are ignored. Omit all address fields for status, nickname or flag changes, including on accounts with no address. An unchanged echo of the stored address is not an address change. Other account types keep their existing address-line behaviour."
        }
      },
      {
        "location": {
          "type": "REQUEST_BODY",
          "path": "/bank-accounts",
          "method": "POST"
        },
        "properties": {
          "description": "Create bank account request. A DEPOSIT virtual account takes its address either as structuredAddress or as addressLine1-3. When structuredAddress has any field set, it is the address: it requires locality, state, postCode, countryCode and streetName, and addressLine1-3 are ignored. Without structuredAddress, addressLine1-3 are the address, with the rules described on each line. Other account types keep their existing address-line behaviour."
        }
      },
      {
        "location": {
          "type": "REQUEST_BODY",
          "path": "/wallets/external",
          "method": "POST"
        },
        "properties": {
          "description": "Registers a wallet you already control. AUDD stores the address only and never holds the keys."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/assets/trustlines",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/assets",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts/{id}",
          "method": "DELETE",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/bank-accounts",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/companies/{id}",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/companies",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/login/two-factor/secret",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Your environment API key, sent raw with no \"Bearer\" prefix. This endpoint proxies directly to the identity provider and does not accept a JWT: sending \"Bearer <token>\" returns 401. The JWT from POST /mfa/login is used on the business endpoints, not here."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/mfa/enable",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Your environment API key, sent raw with no \"Bearer\" prefix. Not the JWT from POST /mfa/login; enrolment happens before you have one."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/mfa/login",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Your environment API key, sent raw with no \"Bearer\" prefix. The token this call returns is what you send as \"Bearer <token>\" on the business endpoints; it is not used here."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/trades/buy",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/trades/sell",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/transactions/{id}",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/transactions",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/users/{id}",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/users",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/wallets/external",
          "method": "POST",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/wallets/{id}/signers",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/wallets/{id}",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/wallets",
          "method": "GET",
          "name": "Authorization"
        },
        "properties": {
          "description": "Bearer JWT obtained from POST /mfa/login. Send as \"Bearer <token>\". Expires after 5 minutes."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "name": "Idempotency-Key"
        },
        "properties": {
          "description": "Unique key for this request, exactly 32 characters. Reusing a key with a different body, or while the first request is still in flight, returns 409."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "name": "Idempotency-Key"
        },
        "properties": {
          "description": "Unique key for this request, exactly 32 characters. Reusing a key with a different body, or while the first request is still in flight, returns 409."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "name": "Idempotency-Key"
        },
        "properties": {
          "description": "Unique key for this request, exactly 32 characters. Replaying the same key with the same body returns the stored response without updating the customer or resetting the applicant again. Reusing a key with a different body, or while the first request is still in flight, returns 409."
        }
      },
      {
        "location": {
          "type": "REQUEST_HEADER",
          "path": "/customer/customers",
          "method": "POST",
          "name": "Idempotency-Key"
        },
        "properties": {
          "description": "Unique key for this request, exactly 32 characters. Reusing a key with a different body, or while the first request is still in flight, returns 409."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/trustlines",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/trustlines",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request. Returned when the body fails validation, when assetId or sourceId does not exist, when the wallet is not active or sits on a different network from the asset, or when the limit is outside the permitted range."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/trustlines",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/trustlines",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden. The wallet or the asset does not belong to your company."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/trustlines",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request. Returned when direction is neither ASC nor DESC."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "No asset exists with that id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}/trustlines",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Asset not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. Returned when a query parameter cannot be parsed, for example a network outside the allowed values or a direction other than ASC or DESC. Also returned by the gateway when the Authorization header is absent."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/assets",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Also returned when the requested page contains an asset that cannot be rendered; narrow the list with network."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/bulk-delete",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Per-account deletion results"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/bulk-delete",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/bulk-delete",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/bulk-delete",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/deposit",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/deposit",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/deposit",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/deposit",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Bank account not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/deposit",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Accepted. The withdrawal record has been created and is being processed; it is normally returned with status IN_PROGRESS rather than DONE. Note that this endpoint answers 200, not 201."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request, in one of two shapes. A missing required field, or a currency outside the allowed values, is rejected by the gateway with {\"message\":\"Invalid request body\"} and no messageKey. Everything else is rejected by the service in the standard error shape with a messageKey: bank_account.invalid_amount (zero, negative, more than two decimal places, or below 0.01), bank_account.bank_balance_insufficient, bank_account.invalid_destination_bank_account (the destination is not a WITHDRAWAL account), bank_account.do_not_allow_on_different_type_issuer_or_platform_bank_account_or_deposit_bank_account (the source is not one of your deposit accounts), bank_account.invalid_currency, bank_account.fee_not_defined, and bank_account.withdrawal.amount_too_small when includeFee leaves nothing after the fee."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden. The token lacks the withdrawal role, or the accounts do not belong to your company."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Bank account not found, with messageKey bank_account.bank_account_not_found. Returned when destBankAccountId does not resolve."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "409"
        },
        "properties": {
          "description": "Conflict, with messageKey bank_account.duplicate_transfer. Returned when idempotencyKey has already been used for a withdrawal with a different payload. Reusing a key with an identical payload is not a conflict: it returns 200 with the original record."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/withdraw",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Also returned when srcBankAccountId does not resolve to an account."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. Returned when a query parameter cannot be parsed, for example a type other than DEPOSIT or WITHDRAWAL, a non-numeric limit or index, or a direction other than ASC or DESC."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}/balance-records",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "DELETE",
          "statusCode": "204"
        },
        "properties": {
          "description": "The account has been deleted. The response has no body. Deleting an account that was already deleted also answers 204."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "DELETE",
          "statusCode": "400"
        },
        "properties": {
          "description": "Missing required request parameters: [Authorization]. Returned by the gateway request validator when the Authorization header is absent, before the request reaches the service."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "DELETE",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "DELETE",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Also returned when the id does not resolve to an account, including when the value is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Missing required request parameters: [Authorization]. Returned by the gateway request validator when the Authorization header is absent, before the request reaches the service."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden, with messageKey bank_account.access_denied. Returned when the account belongs to another company, or when the token lacks the role needed to read bank accounts."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Bank account not found, with messageKey bank_account.bank_account_not_found. Returned both for an id that does not exist and for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success. Returns the account with the new customer details applied."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request, in one of two shapes. A changes array that is absent, empty, longer than two items, contains a null, carries a reason outside the allowed values, or carries a structuredAddress that breaks its schema (a null value, a field longer than its maximum length, or a countryCode that is not two uppercase letters) is rejected by the gateway with {\"message\":\"Invalid request body\"} and no messageKey. Everything else is rejected by the service with messageKey bank_account.invalid_customer_details and a message naming the offending item, for example \"changes[0].reason: reason is required\", \"changes[0]: must contain exactly one category\", \"changes[1]: contains a duplicate address change\", or a field rule such as \"changes[0].accountHolderFirstName: max_length_exceeded\" or \"changes[0].structuredAddress.postCode: Postcode is required\". An account with no bank provider behind it is rejected with messageKey bank_account.do_not_allow_on_different_type_issuer_or_platform_bank_account_or_deposit_bank_account."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden. The account belongs to another company. The messageKey is bank_account.do_not_allow_on_different_type_issuer_or_platform_bank_account_or_deposit_bank_account, the same key used for an ineligible account on a 400, so use the status code to tell the two apart."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "404"
        },
        "properties": {
          "description": "Bank account not found, with messageKey bank_account.bank_account_not_found."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PATCH",
          "statusCode": "502"
        },
        "properties": {
          "description": "The bank provider rejected the customer-details update."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success. Returns the account as it now stands, after the replace."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input, with a messageKey identifying the rule that failed: bank_account.nickname_required (nickname is required on every update, including one that changes nothing else), bank_account.bank_account_already_exist (another account of the same type and sub type in your company already uses this bsb and accountNumber), bank_account.pay_id_already_exists, bank_account.bsb_and_swift_mutually_exclusive, bank_account.invalid_bsb_format, bank_account.invalid_account_number, bank_account.invalid_swift_code and bank_account.invalid_iban. A deposit virtual account also revalidates its customer details, returning the same per-field errors array as POST /bank-accounts."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden. bank_account.status_change_access_denied for a status change without the status role; bank_account.flags_change_access_denied for a change to nameMatchingEnabled or referenceCheckingEnabled without the compliance role, which includes omitting a flag that is currently set; bank_account.deposit_bank_account_access_denied for changing the bsb, accountNumber or payId of a deposit virtual account; and bank_account.access_denied for the payment details of a remitter account or any account belonging to another company."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "statusCode": "404"
        },
        "properties": {
          "description": "Bank account not found, with messageKey bank_account.bank_account_not_found."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts/{id}",
          "method": "PUT",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. Returned when a query parameter cannot be parsed, for example a direction other than ASC or DESC, or a non-numeric limit or index. The body is the standard error shape with a message naming the parameter that failed to convert."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden. The token lacks the role needed to read bank accounts."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Also returned for a limit below 1 or an unrecognised sortBy field."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success. The account is created and returned. Note that this endpoint returns 200 rather than 201."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. The body carries a messageKey identifying the rule that failed: bank_account.company_required, bank_account.nickname_required, bank_account.bank_provider_type_required, bank_account.sub_type_required, bank_account.bank_details_required (bankProviderType NONE or subType WITHDRAWAL must carry bsb, or swiftCode with iban or accountNumber), bank_account.bsb_and_swift_mutually_exclusive, bank_account.invalid_bsb_format, bank_account.invalid_account_number, bank_account.invalid_swift_code, bank_account.invalid_iban.\n\nA DEPOSIT virtual account additionally validates customer details, and those failures return an errors array of {field, messageKey, message} objects naming each offending field, with messageKey carrying the human-readable reason rather than a dotted key. Address failures name the offending field: a structuredAddress field when one is sent, for example structuredAddress.postCode with \"Postcode is required\" when the postcode is missing, otherwise addressLine1 to addressLine3. Customer details rejected by the provider rather than locally, such as a combined account holder name over 35 characters, return messageKey bank_account.invalid_customer_details with the provider's own message."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found. The companyId, or an internalBankAccountId that was supplied, does not resolve to a record you can see."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "POST",
          "statusCode": "409"
        },
        "properties": {
          "description": "Bank account already exists. Returned with messageKey bank_account.pay_id_already_exists when the payId is already in use by another account. Note that a duplicate bsb and accountNumber pair is currently accepted on create rather than rejected here."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/bank-accounts",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Company not found, with messageKey user.company_not_found. Returned for an id that does not exist, for a value that is not a well-formed id, and for a company you cannot see."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/companies",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/auth/token",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "JWT issued"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/auth/token",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied API key was rejected. INVALID_API_KEY: the key is not recognised. INACTIVE_API_KEY: the key was replaced by a rotation, or has passed its 90-day lifetime; issue a new key with Rotate API key in the AUDD Mint Portal (Company > Merchant Security) and update your integration. The X-API-Key header is required and checked at the gateway, so an absent header returns 400, not 401."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/auth/token",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Source IP not in your merchant allowlist, client certificate missing or not registered against your company, or the company is not enabled for merchant API access"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/auth/token",
          "method": "POST",
          "statusCode": "429"
        },
        "properties": {
          "description": "Too many failed authentication attempts from your source IP (20 failures in a rolling 5 minute window); rate limited"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/auth/token",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Customer after assignment"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Missing merchantGroupId or tierId, the tier does not belong to the merchant group, the tier is inactive, or a missing or non-32-character Idempotency-Key. Request body shape is validated at the gateway on this route, so a missing or wrongly typed body field returns the generic 'Invalid request body' message with no field detail; errors raised past the gateway carry a descriptive messageKey."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Customer, merchant group, or tier not found (including when it belongs to another company)"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "409"
        },
        "properties": {
          "description": "The Idempotency-Key was reused for a different request or is still in progress"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/assignment",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "202"
        },
        "properties": {
          "description": "KYC submission accepted for processing"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Missing tierId, the tier does not belong to the customer's merchant group, the onboarding fee configuration is invalid, insufficient funds for the onboarding fee, or a missing or non-32-character Idempotency-Key. Request body shape is validated at the gateway on this route, so a missing or wrongly typed tierId returns the generic 'Invalid request body' message with no field detail; errors raised past the gateway carry a descriptive messageKey."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Customer or tier not found (including when it belongs to another company)"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "409"
        },
        "properties": {
          "description": "The Idempotency-Key was reused for a different request or is still in progress"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}/kyc",
          "method": "POST",
          "statusCode": "503"
        },
        "properties": {
          "description": "Bank service unavailable while validating the onboarding fee; the submission was not accepted and can be retried"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "200"
        },
        "properties": {
          "description": "Customer updated"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "400"
        },
        "properties": {
          "description": "Field-level validation error(s) from backend bean validation, a missing or non-32-character Idempotency-Key, or a merchant group that cannot be assigned (archived, or no active default group)"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "401"
        },
        "properties": {
          "description": "Missing, invalid, or expired token"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "404"
        },
        "properties": {
          "description": "No customer with this id under your company, or the merchant group was not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "409"
        },
        "properties": {
          "description": "Another customer in your company already uses this email, or the Idempotency-Key was reused for a different request or is still in progress"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers/{customerId}",
          "method": "PUT",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Paginated list of customers"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid status or kycStatus value"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Merchant group or tier in the filter not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "201"
        },
        "properties": {
          "description": "Customer created"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Field-level validation error(s) from backend bean validation, a missing or non-32-character Idempotency-Key, or a merchant group that cannot be assigned (archived, or no active default group). The request body on this route is validated by the backend rather than the gateway, so body errors always carry a field-level messageKey; the schema below is descriptive of what the backend accepts and is not enforced at the gateway."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, client certificate/source IP not allowed, or the merchant group belongs to another company"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Merchant group not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "409"
        },
        "properties": {
          "description": "A customer with this email already exists for your company, or the Idempotency-Key was reused for a different request or is still in progress"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/customers",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}/tiers",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "List of tiers in the merchant group"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}/tiers",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}/tiers",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}/tiers",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Merchant group not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}/tiers",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Merchant group"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Merchant group not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups/{groupId}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Paginated list of merchant groups"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/groups",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/tiers/{tierId}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Tier"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/tiers/{tierId}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "The supplied Bearer token was rejected: malformed, bad signature, wrong audience, or expired. The Authorization header is required and checked at the gateway, so an absent header returns 400, not 401. Re-authenticate at POST /customer/auth/token."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/tiers/{tierId}",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Insufficient token scope, or client certificate/source IP not allowed"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/tiers/{tierId}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Tier not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/customer/tiers/{tierId}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/change-password",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/change-password",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Bad request"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/change-password",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Invalid Authorization Header"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/change-password",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "User not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/jwt/refresh",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/jwt/refresh",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "The refresh token was rejected, because it has already been used, has expired, or does not correspond to the supplied access token. The response body is empty: this endpoint does not currently forward the reason given by the identity provider."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/jwt/refresh",
          "method": "POST",
          "statusCode": "502"
        },
        "properties": {
          "description": "Returned for a malformed or empty request body, a missing accessToken or refreshToken field, or a value that cannot be decrypted. The body is {\"message\":\"Internal server error\"} even though the cause is a malformed request, because this endpoint does not validate its input before using it."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/enable",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/enable",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Bad request"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/enable",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Invalid Authorization Header"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/enable",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "User not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/enable",
          "method": "POST",
          "statusCode": "421"
        },
        "properties": {
          "description": "Misdirected request"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/enable",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/secret",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/secret",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Missing required request parameters: [Authorization]. Returned by the gateway request validator when the Authorization header is absent, before the request reaches the identity provider."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor/secret",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Invalid Authorization Header. Returned when the header is present but is not a valid API key, including when a Bearer JWT is sent instead of the raw key."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login/two-factor",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login",
          "method": "POST",
          "statusCode": "405"
        },
        "properties": {
          "description": "Invalid input"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/login",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/enable",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/enable",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request. Returned when the Authorization header is absent, when a required body field is missing, when mfaSecretB32 is not Base32 (for example the raw secret value from GET /login/two-factor/secret, or a lowercased string), or when mfaCode is not exactly six digits. Field errors return {\"message\":\"<reason>\",\"errors\":[\"<reason>\"]}; a malformed JSON body returns a plain-text reason instead of JSON."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/enable",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Authorization header present but empty, or rejected by the identity provider."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/enable",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "The username or password was not accepted. The identity provider does not distinguish an unknown user from a wrong password, and the passed-through body carries no detail."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/enable",
          "method": "POST",
          "statusCode": "409"
        },
        "properties": {
          "description": "MFA is already enabled for this user. Enrolment is one-time; removing an existing authenticator so a user can re-enrol requires AUDD."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/enable",
          "method": "POST",
          "statusCode": "421"
        },
        "properties": {
          "description": "The mfaCode did not match mfaSecretB32. Six well-formed but incorrect digits produce this status, passed through from the identity provider. Retry with a freshly generated code; if it keeps failing, check the client clock for drift."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/login",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/login",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request. Returned when the Authorization header is absent, when a required body field is missing, or when mfaCode is not exactly six digits. Field errors return {\"message\":\"<reason>\",\"errors\":[\"<reason>\"]}; a malformed JSON body returns a plain-text reason instead of JSON."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/login",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Authorization header present but empty, or rejected by the identity provider."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/login",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "MFA is not enabled for this user. The credentials were accepted but no authenticator is registered, so the user must complete POST /mfa/enable first."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/login",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "The username or password was not accepted. The identity provider does not distinguish an unknown user from a wrong password, and the passed-through body carries no detail."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/mfa/login",
          "method": "POST",
          "statusCode": "421"
        },
        "properties": {
          "description": "The mfaCode was six well-formed digits but did not match the user's registered authenticator, passed through from the identity provider. Retry with a freshly generated code; if it keeps failing, check the client clock for drift."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/networks",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/payments",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success. Body: tradeWallet (the resolved burn wallet), burnWallets (array of burn wallets with id, address, publicKey, network, status; send AUDD to address on EVM networks and to publicKey on Stellar), asset, distributorCompany, distributorWallet when walletId was supplied, buyEnabled, sellEnabled."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid request. Returned when the path parameter is not an asset id that resolves, when walletId names a wallet that cannot be used with this asset, or (asset.distributor_wallet_required) when walletId is omitted by a caller that does not belong to a company."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/burn-wallet/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/buy",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Accepted. The trade has been created and the mint is under way; it is not complete when this returns."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/buy",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input, with a messageKey identifying the rule that failed: trade.bank_account_required, trade.wallet_required, trade.asset_required, trade.asset_amount_required, bank_account.currency_required, bank_account.invalid_amount (assetAmount may have at most 7 decimal places), and trade.asset_not_found when assetId does not resolve. Insufficient funds in the bank account are also rejected here."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/buy",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/buy",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found. The bank account or wallet does not resolve to a record you can see."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/buy",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/sell",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Accepted. The SELL trade has been created; the AUD settles asynchronously."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/sell",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input, with a messageKey identifying the rule that failed: trade.bank_account_required, trade.wallet_required, trade.asset_required, trade.asset_amount_required, bank_account.currency_required, bank_account.invalid_amount (assetAmount may have at most 7 decimal places), and trade.asset_not_found when assetId does not resolve."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/sell",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/sell",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found. The bank account or wallet does not resolve to a record you can see."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/sell",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/swap",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/swap",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/swap",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/trades/swap",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "statusCode": "400"
        },
        "properties": {
          "description": "The transaction cannot be cancelled. The messageKey says why: transaction.only_pending_tx_allowed when it is not PENDING, transaction.action_not_allowed_on_parent_tx when it groups other transactions, transaction.tx_in_progress when it is already being submitted, transaction.only_creator_can_cancel when you neither created it nor can sign for it, and transaction.cannot_cancel_transaction_of_type_cancel when it is itself a cancellation."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "statusCode": "404"
        },
        "properties": {
          "description": "No transaction exists with that id, with messageKey transaction.tx_not_found. Also returned for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/cancel",
          "method": "PUT",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "statusCode": "400"
        },
        "properties": {
          "description": "The transaction cannot be resubmitted. The messageKey says why: transaction.only_failed_tx_allowed when its status is not FAILED, transaction.source_is_external when it was sent from a wallet you hold yourself, and transaction.action_not_allowed_on_parent_tx when it groups other transactions."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden, with messageKey transaction.access_denied. The transaction was not sent from one of your wallets."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "statusCode": "404"
        },
        "properties": {
          "description": "No transaction exists with that id, with messageKey transaction.tx_not_found. Also returned for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/resubmit",
          "method": "PUT",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "The transaction cannot be signed. Returned by the gateway when the Authorization header is absent, and by the service with a messageKey saying why: transaction.invalid_signer when you are not a signer on the source wallet, transaction.tx_already_done, transaction.tx_already_canceled or transaction.tx_failed when it has already reached that state, transaction.tx_in_progress or transaction.tx_being_created while it is still being handled, and transaction.previous_transaction_is_pending when an earlier transaction in the same group has not settled."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden, with messageKey transaction.access_denied. The transaction was not sent from one of your wallets."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "No transaction exists with that id, with messageKey transaction.tx_not_found. Also returned for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}/sign",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Signing a parent transaction whose grouped transactions have all settled is rejected with a 500."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}",
          "method": "GET",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden, with messageKey transaction.access_denied. The transaction was neither created by your company nor sent from one of your wallets."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "No transaction exists with that id, with messageKey transaction.tx_not_found. Also returned for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. Returned when a query parameter cannot be parsed, for example a non-numeric limit or index, or a direction other than ASC or DESC."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/transactions",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users/{id}",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Returned by the gateway when the Authorization header is absent. Note that a malformed id is not a 400: it is treated as a user that does not exist and returns 404."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "User not found, with messageKey user.user_not_found. Returned both for an id that does not exist and for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. Returned when a query parameter cannot be parsed, for example a direction other than ASC or DESC, or a non-numeric limit or index. Also returned by the gateway when the Authorization header is absent."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/users",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Also returned for a limit below 1 or an unrecognised sortBy field."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/external",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success. The wallet is registered and returned. Note that this endpoint answers 200, not 201."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/external",
          "method": "POST",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. The body carries a messageKey identifying the rule that failed: wallet.company_id_required, wallet.nick_name_required, wallet.type_required, wallet.network_required, and wallet.invalid_external_wallet_type when type is anything other than DISTRIBUTOR or CUSTOMER. A missing publicKey is rejected with the plain message \"must not be blank\" and no messageKey, and a network or type outside the allowed values is rejected without a messageKey as well."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/external",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/external",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden. The token lacks the role needed to register an external wallet."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/external",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found. The companyId does not resolve to a company you can see."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/external",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/friendbot",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/friendbot",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/friendbot",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/friendbot",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Wallet not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/friendbot",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/signers",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/signers",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/signers",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Wallet not found, with messageKey wallet.wallet_not_found."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/signers",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success. Returns the wallet as it now stands, including any status change."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "statusCode": "404"
        },
        "properties": {
          "description": "Wallet not found, with messageKey wallet.wallet_not_found. Returned for an id that does not exist and for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}/sync",
          "method": "PUT",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Wallet not found, with messageKey wallet.wallet_not_found. Returned for an id that does not exist and for a value that is not a well-formed id."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets/{id}",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "GET",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "GET",
          "statusCode": "400"
        },
        "properties": {
          "description": "Invalid input. Returned when a query parameter cannot be parsed, for example a status or type outside the allowed values, a direction other than ASC or DESC, or a non-numeric limit or index. Also returned by the gateway when the Authorization header is absent."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "GET",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized. The bearer token is missing, expired or invalid. The response body is empty."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "GET",
          "statusCode": "404"
        },
        "properties": {
          "description": "Not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "GET",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error. Also returned for a limit below 1 or an unrecognised sortBy field."
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "POST",
          "statusCode": "200"
        },
        "properties": {
          "description": "Success"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "POST",
          "statusCode": "401"
        },
        "properties": {
          "description": "Unauthorized"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "POST",
          "statusCode": "403"
        },
        "properties": {
          "description": "Forbidden"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "POST",
          "statusCode": "404"
        },
        "properties": {
          "description": "Wallet not found"
        }
      },
      {
        "location": {
          "type": "RESPONSE",
          "path": "/wallets",
          "method": "POST",
          "statusCode": "500"
        },
        "properties": {
          "description": "Internal server error"
        }
      }
    ]
  },
  "x-amazon-apigateway-security-policy": "TLS_1_0",
  "x-amazon-apigateway-request-validators": {
    "Validate body, query string parameters, and headers": {
      "validateRequestParameters": true,
      "validateRequestBody": true
    },
    "Validate query string parameters and headers": {
      "validateRequestParameters": true,
      "validateRequestBody": false
    }
  }
}
```