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

accountSetupSession

Overview

This query gets data from the active account setup session.

Special Considerations

None.

Inputs

None.

Returns

Promise<AccountSetupSessionResult>

This query returns a promise containing the following object / data:

AccountSetupSessionResult {
  slug: string
  accountType: string
  addressLine1: string
  addressLine2: string
  city: string
  zoneCode: string
  postalCode: string
  country: Country
  uploadedId: boolean
  identificationType: string
  bankName: string
  firstName: string
  middleName: string
  lastName: string
  phone: string
  phoneCountryCode: Country
  date of Birth: DateTime
  personalTaxId: string
  citizenship: string
  name: string
  displayName: string
  businessType: string
  businessTaxId: string
  industry: string
  estimatedMonthlyVolume: float
  estimatedMonthlyTransactions: int
  businessSize: int
  jobTitle: string
  zoneCodeOfIncorporation: string
}

Example

Running this query:

query {
  accountSetupSession {
    slug
    accountType
    addressLine1
    addressLine2
    city
    postalCode
    country
    uploadedId
    identificationType
    bankName
    firstName
    lastName
    dateOfBirth
  }
}

Gives us:

{
  "data": {
    "accountSetupSession": {
      "slug": "testing-slug",
      "accountType": "PERSONAL",
      "addressLine1": "123 Fouveaux Street",
      "addressLine2": null,
      "city": "Sydney",
      "postalCode": "0844",
      "country": "AU",
      "uploadedId": false,
      "identificationType": "SSN",
      "bankName": "Test Bank",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": 1990-06-12T18:53:03.128Z
    }
  }
}

Common Errors

  • Session expired. (I-4310)
    • The setup sesssion expired. Start a new setup session.
← accountIdentificationTypesallCountries →
  • Overview
  • Special Considerations
  • Inputs
  • Returns
    • Promise<AccountSetupSessionResult>
  • Example
  • Common Errors
borderless Docs
Docs
Account SetupAccount ServicesVerificationPaymentsRefundsDeveloper Tools
More
LoginBlogGitLabLinkedInInstagramTwitter
Facebook Open Source
Copyright © 2022 borderless