v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
SDK

Fetch user profile for the current authenticated user

get/sdk/{environmentId}/users

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Response

successful lookup

idstring required
projectEnvironmentIdstring required
lastVerifiedCredentialIdstring
sessionIdstring
aliasstring nullable
countrystring nullable

Standard ISO 3166-1 alpha-2 two-letter country code

emailstring email nullable
firstNamestring nullable
jobTitlestring nullable
lastNamestring nullable
phoneNumberstring nullable
policiesConsentboolean nullable
tShirtSizestring nullable
teamstring nullable
usernamestring nullable
firstVisitstring date-time
lastVisitstring date-time
newUserboolean
metadataobject
mfaBackupCodeAcknowledgement'pending' | 'complete' nullable
btcWalletstring nullable
kdaWalletstring nullable
ltcWalletstring nullable
ckbWalletstring nullable
kasWalletstring nullable
dogeWalletstring nullable
emailNotificationboolean nullable
discordNotificationboolean nullable
newsletterNotificationboolean nullable
listsstring[]

Access lists evaluated by Dynamic when considering access for the user.

scopestring

A whitespace-separate list of permissions associated with the JWT token issued. This conforms to the JWT standard for scope claims: https://datatracker.ietf.org/doc/html/rfc8693#section-4.2

Example response

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
  "verifiedCredentials": [
    {
      "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
      "refId": "95b11417-f18f-457f-8804-68e361f9164f",
      "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "wallet_properties": {
        "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
        "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
        "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
        "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f"
      },
      "phoneNumber": "9171113333",
      "phoneCountryCode": "1",
      "isoCountryCode": "US",
      "previous_users": [
        "95b11417-f18f-457f-8804-68e361f9164f"
      ]
    }
  ],
  "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
  "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
  "alias": "An example name",
  "country": "US",
  "firstName": "An example name",
  "jobTitle": "An example name",
  "lastName": "An example name",
  "tShirtSize": "An example name",
  "team": "An example name",
  "username": "An example name",
  "scope": "superuser marketing operations",
  "missingFields": [
    {
      "validationRules": {
        "regex": "^0x",
        "validOptions": [
          {
            "label": "small"
          },
          {
            "label": "medium"
          },
          {
            "label": "large"
          }
        ],
        "checkboxText": "Agree to the terms and conditions"
      }
    }
  ]
}