borderless Docs

borderless Docs

  • Account Setup
  • Account Services
  • Verification
  • Payments
  • Refunds
  • Developer Tools

›Queries

Account Setup

    Queries

    • accountIdentificationTypes
    • accountSetupSession
    • allCountries
    • businessTypes
    • isValidBusinessTaxId
    • isValidPersonalTaxId
    • isValidSlug
    • jobTitles
    • naics
    • supportedCountries
    • zoneCodes

    Mutations

    • addAccountToPerson
    • addCompanyOfficerToAccount
    • createAccountSetupSession
    • createLoginPersonAndAccount
    • deactivateAccount
    • resendEmailVerification
    • submitAccountSetupSession
    • submitCompanyOfficers
    • updateAccountSetupSession

Account Services

    Queries

    • account
    • accounts
    • bankAccounts
    • companyOfficers
    • person
    • publicAccountBySlug

    Mutations

    • addBankAccount
    • changePassword
    • changePreferredBankAccount
    • login
    • logout
    • requestPasswordReset
    • sendInvitationEmail
    • sendInvitedRegisterEmail
    • switchAccounts
    • updateAccount
    • updatePerson

Verification

    Mutations

    • addOnfidoDocumentToPerson
    • embedOnfido

Payments

    Queries

    • contacts
    • paymentActivity
    • paymentActivityById
    • paymentRequestById
    • paymentSession
    • requestedPayments
    • tradeConfirmationForPayment

    Mutations

    • clearPaymentSession
    • createPaymentForRequestSession
    • createPaymentSession
    • declinePaymentRequest
    • generatePayMeRequest
    • requestPayment
    • resendPaymentRequest
    • submitPaymentSession
    • updatePaymentSession
    • updateQuote

Refunds

    Queries

    • refundSession

    Mutations

    • clearRefundSession
    • createRefundSession
    • submitRefundSession
    • updateRefundSession

Developer Tools

    Queries

    • accountWebhooks
    • embedVerificationService

    Mutations

    • createWebhook
    • healthCheck
    • testWebhook

companyOfficers

Overview

This query returns an array of objects, each object containing the queried information for each company officer on the current account.

Special Considerations

  • Returns list of queried information.
  • Does not take an input.

Inputs

N/A

Returns

Promise<CompanyOfficer[]>

A promise containing an array of CompanyOfficer objects.

CompanyOfficer

Each CompanyOfficer object represents an officer, containing the following fields.

name: String
percentOfOwnership: Float
type: CompanyOfficerType
dateOfBirth: DateTime
jobTitle: String

Example

Running this query:

query {
  companyOfficers {
    name
    percentOfOwnership
    type
    jobTitle
    dateOfBirth
  }
}

Gives us:

{
  "data": {
    "companyOfficers": [
      {
        "name": "Aaron",
        "percentOfOwnership": 25,
        "type": "Director",
        "jobTitle": "Accoutant",
        "dateOfBirth": "1999-01-01"
      },
      {
        "name": "Alex",
        "percentOfOwnership": 25,
        "type": "UBO",
        "jobTitle": "Accoutant",
        "dateOfBirth": "1990-10-10"
      },
      ...
    ]
  }
}

Common Errors

N/A

← bankAccountsperson →
  • Overview
  • Special Considerations
  • Inputs
  • Returns
    • Promise<CompanyOfficer[]>
  • Example
  • Common Errors
borderless Docs
Docs
Account SetupAccount ServicesVerificationPaymentsRefundsDeveloper Tools
More
LoginBlogGitLabLinkedInInstagramTwitter
Facebook Open Source
Copyright © 2022 borderless