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

person

Overview

This query returns a person's information based on the user that is logged in during the current session.

Special Considerations

  • Query does not take in any inputs

Inputs

N/A

Returns

Promise<PrivatePerson>

A promise containing the following object / data:

PrivatePerson: {
    id: ID,
    idUploaded: boolean,
    firstName: string,
    middleName: string,
    lastName: string,
    email: string,
    emailVerified: string,
    phoneCountryCode: COUNTRY,
    phhone: string,
    dateOfBirth: DateTime,
    personalTaxId: string,
    avatarLink: string
}

Example

Running this query:

query {
  person {
    id
    idUploaded
    firstName
    middleName
    lastName
    email
    emailVerified
    phoneCountryCode
    phone
    dateOfBirth
    personalTaxId
    avatarLink
  }
}

Gives us:

{
  "data": {
    "person": {
      "id": "ckb6trqis00fb0772k405twot",
      "idUploaded": true,
      "firstName": "Jane",
      "middleName": null,
      "lastName": "Smith",
      "email": "docexample@getborderless.co",
      "emailVerified": true,
      "phoneCountryCode": "US",
      "phone": "1234567890",
      "dateOfBirth": "1990-01-01",
      "personalTaxId": "123456789",
      "avatarLink": null
    }
  }
}

Common Errors

N/A

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