For the complete documentation index, see llms.txt. This page is also available as Markdown.

Disable, Activate and Update sub-clients

You can disable and activate sub-clients. Deposits sent to a disabled sub-client will no longer be booked against your balance.

Disabling a sub-client

const bodyJSON = {
  variables: {
    input: "606128f24bf29139b2cf74ef",
  },
  query: `
mutation ($input: ID!) {
  disableSubClient(id: $input) {
    success code message 
    subClient {
      id status
    }
  }
}`,
};
mutation($input: ID!) {
  disableSubClient(id: $input) {
    success
    code
    message
    subClient {
      id
      status
    }
  }
}

Activating a sub-client

const bodyJSON = {
  variables: {
    input: "606128f24bf29139b2cf74ef",
  },
  query: `
mutation ($input: ID!) {
  activateSubClient(id: $input) {
    success code message 
    subClient {
      id status
    }
  }
}`,
};
mutation($input: ID!) {
  activateSubClient(id: $input) {
    success
    code
    message
    subClient {
      id
      status
    }
  }
}

Updating sub-clients

At this point, you can only update the externalId, address, postalAddress and principals properties because each sub-client has a set of linked domestic and international Virtual Account Numbers to send and receive funds.

You cannot change the account holders of a joint sub-client. If the holders change, create a new sub-client and disable the old one.

Please note, that the updated address will be re-verified, so make sure to include all its components, even if some fields, like the country, remain unchanged.

Updating sub-client externalId

The same uniqueness rule applies when updating: if the new externalId is already used by another of your sub-clients, the update is rejected with DUPLICATE_SUBCLIENT, and the sub-client is left unchanged. Re-sending a sub-client's own current externalId is accepted.

Updating sub-client address

Updating sub-client principals

principals is the complete list of the people who own or control a COMPANY sub-client. What you send replaces what is on record:

  • an entry with an id - that principal is updated

  • an entry without an id - a new principal is added

  • a principal on record whose id you do not send - that principal is removed and is no longer returned

Every entry needs the person's full details (roles, firstName, lastName, plus middleName and dob if you have them), even when you only change their roles. Optional fields you leave out are kept as they are. The list cannot be left with no one: omitting principals, or sending an empty list, leaves the principals unchanged. An id that does not belong to this sub-client is rejected with NOT_FOUND, and principals on an INDIVIDUAL or JOINT sub-client are rejected.

In the example below the sub-client had two principals on record: Wei Zhang (68d4c3a1f2b9e07c4d1a5b01, director and ultimate beneficial owner) and Mei Lin (68d4c3a1f2b9e07c4d1a5b02, beneficial owner). The request keeps Wei as a director only, adds Carol Nguyen as the company secretary, and removes Mei because her id is not in the list.

Last updated

Was this helpful?