Skip to main content

Branch offices

A branch office is a physical or organizational unit of your bank. Branch offices can be associated with organizations and organization invitations to scope access and reporting.

All mutations on this page require a JWT — get one from the homepage first.

Add a branch office​

Creates a new branch office under the authenticated bank. The payload wraps the branch office in an inner branchOfficePayload — projecting through the wrapper is required.

mutation addBranchOffice($input: AddBranchOfficeInput!) {
addBranchOffice(input: $input) {
  branchOfficePayload {
    branchOffice {
      id
      name
    }
  }
}
}

The name is required and must be 1–100 characters.

Update a branch office​

name is optional — omit it to leave the existing value unchanged. Same wrapped-payload shape as addBranchOffice.

mutation updateBranchOffice($input: UpdateBranchOfficeInput!) {
updateBranchOffice(input: $input) {
  branchOfficePayload {
    branchOffice {
      id
      name
    }
  }
}
}

Remove a branch office​

Permanently deletes a branch office. Payload is flat — just success. Fails with Branch office with id (...) not found if the ID doesn't belong to your bank.

mutation removeBranchOffice($input: RemoveBranchOfficeInput!) {
removeBranchOffice(input: $input) {
  success
}
}