REST APIOrganizationOrganization Management

GET

Get user by id

Path Params

  • userId string required

Query Params

  • organizationId string required

Responses

200

Response Body

object

  • user object required
    user object
    • id string required
    • username string required
    • name object required
      name object
      • first string required
      • full string required
      • last string required
    • enterprises array of objects required
      enterprises object
      • permissions array of strings required
      • id string
      • beneficialOwner boolean
      • name string
    • email object required
      email object
      • email string required
      • verified boolean required
    • agreements object required
      agreements object
      • patriotAct number required
      • termsOfUse number required
      • patriotActAcceptanceDate string
      • termsOfUseAcceptanceDate string
    • allowedCoins array of strings required
    • bitgoEmployee boolean required
    • currency object required
      currency object
      • bitcoinUnit string required
      • currency string required
    • disableReset2FA boolean required
    • organizations array of objects required
      organizations object
      • permissions array of string enums required
        admin
      • role string enum required
        adminmembercustomer
      • id string
      • name string
    • featureFlags array of strings required
    • forceResetPassword boolean required
    • identity object required
      identity object
      • kyc object
        kyc object
        • available boolean required
        • required boolean required
        • data object
          data object
          • state string enum required
            unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
          • fields object

            ANY OF

            object

        • documents object
          documents object
          • state string enum required
            unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
        • failureCount number
        • fullyRequired boolean
        • hasVideoID boolean
        • overallState string enum
          unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
        • passport object
          passport object
          • required boolean required
          • state string enum
            unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
        • residency object
          residency object
          • state string enum required
            unverifiedpendingapprovedrejectedqrscannedinreviewflaggedflagged_retry_allowed
        • isScreeningRequired boolean
        • enterpriseVideoCallInfo array of objects
          enterpriseVideoCallInfo object
          • enterpriseId string required
          • videoCallId string required
      • verified boolean
    • otpDevices array of objects required
      otpDevices object
      • createDate string required
      • id string required
      • backupPhone string
      • label string
      • lastValidatedDate string
      • phone string
      • registeredKey object
        registeredKey object
        • certificate string
        • keyHandle string
        • publicKey string
      • type string enum
        authytotpu2fwebauthnyubikey
      • verified boolean
      • scopes array of string enums
        wallet_hot
      • extensions map of booleans
        extensions object
        • <key> boolean
      • prfSalt string
    • phone object required
      phone object
      • phone string or object required
      • verified boolean required
    • timezone string required
    • apps object nullable
    • country string
    • ecdhKeychain string or object
    • isActive boolean
    • isFrozen boolean
    • freezeReason string
    • lastLogin string
    • locale string
    • pgpKey string
    • rateLimits object nullable
    • referrer object
      referrer object
      • campaign string or object
      • source string or object
    • signupDomain string
    • state string
    • sourceVerificationRequired boolean
    • sourceVerificationRequiredForReadOnlyAccess boolean
    • recoveryCodeSet object
      recoveryCodeSet object
      • id string required
      • allCodesUsed boolean required