--- updatedAt: 2026-07-21T00:05:03.000Z agentTools: projectIndex: https://developer.veem.com/llms.txt --- # addBankAccount # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "description": "Veem REST API", "version": "v1.2.1", "title": "Veem API v1.2" }, "tags": [ { "name": "bank-account-controller", "description": "Bank Account Controller" } ], "paths": { "/veem/v1.2/account/bank-account": { "post": { "tags": [ "bank-account-controller" ], "summary": "addBankAccount", "operationId": "addBankAccountUsingPOST", "requestBody": { "$ref": "#/components/requestBodies/BankAccountRequest" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountResponse" } } } } }, "deprecated": false } } }, "servers": [ { "url": "//sandbox-api.veem.com" } ], "components": { "requestBodies": { "BankAccountRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountRequest" } } }, "description": "request", "required": true } }, "schemas": { "AddressRequest": { "type": "object", "required": [ "city", "line1", "line2", "postalCode", "stateProvince" ], "properties": { "city": { "type": "string", "description": "City" }, "line1": { "type": "string", "description": "Address line 1" }, "line2": { "type": "string", "description": "Address line 2" }, "postalCode": { "type": "string", "description": "Postal code" }, "province": { "type": "string" }, "state": { "type": "string" }, "stateProvince": { "type": "string", "description": "State or province" } }, "title": "AddressRequest" }, "AlignMonetaryAmount": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "number": { "type": "number" } }, "title": "AlignMonetaryAmount" }, "BankAccountAddressDTO": { "type": "object", "properties": { "bankAccountId": { "type": "integer", "format": "int64" }, "city": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "postalCode": { "type": "string" }, "province": { "type": "string" }, "state": { "type": "string" } }, "title": "BankAccountAddressDTO" }, "BankAccountRequest": { "type": "object", "properties": { "accountType": { "type": "string" }, "bankAccountNumber": { "type": "string" }, "bankAddress": { "$ref": "#/components/schemas/AddressRequest" }, "bankCnaps": { "type": "string" }, "bankCode": { "type": "string" }, "bankIfscBranchCode": { "type": "string" }, "bankInstitutionNumber": { "type": "string" }, "bankName": { "type": "string" }, "beneficiaryName": { "type": "string" }, "branchCode": { "type": "string" }, "bsbBankCode": { "type": "string" }, "clabe": { "type": "string" }, "currencyCode": { "type": "string" }, "iban": { "type": "string" }, "isoCountryCode": { "type": "string" }, "routingNumber": { "type": "string" }, "sortCode": { "type": "string" }, "swiftBic": { "type": "string" }, "transitCode": { "type": "string" } }, "title": "BankAccountRequest" }, "BankAccountResponse": { "type": "object", "properties": { "accountHash": { "type": "string" }, "accountId": { "type": "integer", "format": "int64" }, "accountNickname": { "type": "string" }, "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "Checking", "Savings" ] }, "address": { "$ref": "#/components/schemas/BankAccountAddressDTO" }, "bankName": { "type": "string" }, "beneficiaryName": { "type": "string" }, "bic": { "type": "string" }, "canRemove": { "type": "boolean" }, "description": { "type": "string" }, "externalAccountLinked": { "type": "boolean" }, "externalAccountStatus": { "type": "string", "enum": [ "AccountLocked", "AccountMissing", "AccountNotSetUp", "AccountNotSupported", "Connected", "Disconnected", "ExternalError", "InstitutionNotSupported", "InvalidCredentials", "InvalidPin", "InvalidToken", "MFANotSupported", "MFAReset", "ModifiedBankInfo", "NotConfigured" ] }, "extraInfo": { "type": "object", "additionalProperties": { "type": "object" } }, "iban": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "isoCountryCode": { "type": "string", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "isoCurrencyCode": { "type": "string" }, "miscBankFee": { "$ref": "#/components/schemas/AlignMonetaryAmount" }, "routingNumber": { "type": "string" }, "shortIdentifierDomestic": { "type": "string" }, "shortIdentifierInternational": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Deleted", "Inactive", "Inactiving", "Closed" ] }, "validationStatus": { "type": "object", "additionalProperties": { "type": "object" } }, "verificationReason": { "type": "object", "additionalProperties": { "type": "object" } }, "verificationStatus": { "type": "string", "enum": [ "Unverified", "VerificationInProgress", "Verified", "CannotBeVerified", "NeedMoreInfo" ] } }, "title": "BankAccountResponse" } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": true } } ```