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

accountIdentificationTypes

Overview

This query gets a list of all valid identification types for each country.

Special Considerations

None.

Inputs

None.

Returns

Promise<AccountIdentificationResult>

A promise containing the following data (for each country):

AccountIdentificationResult: {
  data: json
}

Where the json asks for each country's accepted verification types for both corporate and private entities (i.e. for the US, accepts Employer Identification Number for business accounts, and either SSN, Passport, Driver's License, or Personal ID Number for private accounts).

Where the json asks for each country's accepted verification types for both corporate and private entities (i.e. for the US, accepts Employer Identification Number for business accounts, and either SSN, Passport, Driver's License, or Personal ID Number for private accounts).

Example

Running this query:

query {
  accountIdentificationTypes {
    data
  }
}

Gives us:

{
  "data": {
    "accountIdentificationTypes": {
      "data": {
        "US": {
          "corporate": {
            "0": "EmployerIdentificationNumber_EIN"
          },
          "private": {
            "0": "SocialSecurityNumber_SSN",
            "1": "Passport",
            "2": "DriversLicense",
            "3": "PersonalIdentificationNumber"
          }
        },
        "AU": {
          "corporate": {
            "0": "AustralianBusinessNumber_ABN"
          },
          "private": {
            "0": "TaxFileNumber_TFN",
            "1": "Passport",
            "2": "DriversLicense",
            "3": "PersonalIdentificationNumber"
          }
        },
        "CA": {
          "corporate": {
            "0": "EmployerIdentificationNumber_EIN"
          },
          "private": {
            "0": "SocialInsuranceNumber_SIN",
            "1": "Passport",
            "2": "DriversLicense",
            "3": "PersonalIdentificationNumber"
          }
        },
        "GB": {
          "corporate": {
            "0": "Value_AddedTax_VAT"
          },
          "private": {
            "0": "NationalIdentificationNumber",
            "1": "Passport",
            "2": "DriversLicense",
            "3": "PersonalIdentificationNumber"
          }
        }
      }
    }
  }
}

Common Errors

N/A

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