Skip to content
Developers
Back to Steward

Apply one update to several applications

POST
/api/v1/applications/bulk/update

Applies the public application update patch to every selected application. Applications already matching the resulting state are skipped.

Authorizations

Section titled “ Authorizations ”

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
object
applicationIds
required

Applications the action applies to

Array<string>
<= 500 items
patch
required

Update applied to every selected application

object
labelIds

Label IDs to assign to the application

Array<string>
displayConfiguration

Display configuration for hiding fields and sections

object
hiddenFields
Array<string>
hiddenSections
Array<string>
unmappedResponseUpdates

Key-value pairs to update in unmappedResponses. Key format: stepId.valueId for regular fields, or fatcaCrs.fieldKey for FATCA fields.

object
key
additional properties
any
individualApplication
object
firstName
string
middleName
string
lastName
string
countryOfBirth

ISO 3166-1 alpha-2 country code

string format: iso-3166-1-alpha-2
nationality

ISO 3166-1 alpha-2 country code

string format: iso-3166-1-alpha-2
address
object
street
string
apartment
string
city
string
state
string
country
string
postalCode
string
phoneNumber
object
countryCode
required
string
phoneNumber
required
string
otherNationality

ISO 3166-1 alpha-2 country code

string format: iso-3166-1-alpha-2
email
string
amountToBeInvested
number
amountToBeInvestedCurrency
string
usCitizen
boolean
isPEP
boolean
employmentStatus
string
occupation
string
accountTurnover
string
annualFlow
string
estimatedNumberOfPayments
number
expectedFxRequirement
string
currenciesRequired
Array<string>
countriesSentTo
Array<string>
countriesReceivedFrom
Array<string>
paymentPurpose
string
fundingSource
string
dateOfBirth
string format: date-time
taxResidences
Array<object>
object
country
string
tin
string
tradingExperience
object
shares
string
derivatives
string
otcDerivatives
string
tradingMethod
string
hasOccupationalExperience
boolean
hasFormalQualification
boolean
businessApplication
object
name
string
registrationNumber
string
jurisdiction

ISO 3166-1 alpha-2 country code

string format: iso-3166-1-alpha-2
trustType
string
legalForm
string
purpose
string
businessActivity
string
industry
string
subIndustry
string
address
object
street
string
apartment
string
city
string
state
string
country
string
postalCode
string
registeredAddress
object
street
string
apartment
string
city
string
state
string
country
string
postalCode
string
tradingAddress
object
street
string
apartment
string
city
string
state
string
country
string
postalCode
string
phoneNumber
object
countryCode
required
string
phoneNumber
required
string
website
string
sicCode
string
vatNumber
string
taxId
string
referrer
string
referrerNote
string
companyTurnover
string
annualFlow
string
estimatedNumberOfPayments
number
expectedFxRequirement
string
currenciesRequired
Array<string>
countriesSentTo
Array<string>
countriesReceivedFrom
Array<string>
paymentPurpose
string
fundingSource
string
investmentAmount
number
investmentAmountCurrency
string
isAudited
boolean
isRegulated
boolean
nullable
hasPep
boolean
ownershipLayers
number
>= 1 <= 3
legalEntityType
string
regulatoryAuthority
string
nullable
regulatoryNumber
string
nullable
incorporationDate
string format: date-time
establishmentDate
string format: date-time
registrationDate
string format: date-time
tradingExperience
object
shares
string
derivatives
string
otcDerivatives
string
tradingMethod
string
hasOccupationalExperience
boolean
hasFormalQualification
boolean
metadata

Arbitrary key-value metadata. Up to 50 key-value pairs. Keys: 1-40 chars, letters/digits/hyphens/underscores only. Values: strings up to 500 chars. On update, send null as a value to delete a key; send {} to clear all metadata.

object
key
additional properties
string
nullable
Examples
{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8",
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "patch": {
    "metadata": {
      "externalRef": "abc-123"
    }
  }
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”
Media type application/json
object
applicationIds
required

Applications this call changed

Array<string>
skippedApplicationIds
required

Applications already in the requested state, left untouched

Array<string>
changedCount
required

How many applications changed

number
skippedCount
required

How many applications were already in the requested state

number
emailFailedApplicationIds

Ids from applicationIds whose onboarding email resend failed; omitted when none

Array<string>
Examples
{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8"
  ],
  "skippedApplicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "changedCount": 2,
  "skippedCount": 1
}