POST
/
environments
/
{environmentId}
/
users
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "alias": "An example name",
  "firstName": "An example name",
  "lastName": "An example name",
  "jobTitle": "An example name",
  "phoneNumber": "An example name",
  "metadata": {},
  "mfaBackupCodeAcknowledgement": "pending",
  "tShirtSize": "An example name",
  "team": "An example name",
  "policiesConsent": true,
  "country": "US",
  "username": "johndoe",
  "btcWallet": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5",
  "kdaWallet": "k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  "ltcWallet": "LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax",
  "ckbWallet": "ckt1q9876543210abcdefghijklmnopqrstuvwxyz",
  "kasWallet": "kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m",
  "dogeWallet": "DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB",
  "emailNotification": true,
  "discordNotification": true,
  "newsletterNotification": true,
  "emailVerifiedAt": "2023-11-07T05:31:56Z",
  "email": "hello-world@foobar.com",
  "wallets": [
    {
      "publicWalletAddress": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
      "chain": "ETH",
      "walletName": "An example name",
      "walletProvider": "browserExtension",
      "additionalWalletAddresses": [
        {
          "address": "<string>",
          "publicKey": "<string>",
          "type": "ordinals"
        }
      ]
    }
  ],
  "oauthAccounts": [
    {
      "provider": "emailOnly",
      "accountId": "An example name",
      "emails": [
        "hello-world@foobar.com"
      ],
      "displayName": "An example name",
      "username": "An example name",
      "photos": [
        "<string>"
      ],
      "profile": {}
    }
  ]
}'
{
  "user": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "verifiedCredentials": [
      {
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "chain": "<string>",
        "refId": "95b11417-f18f-457f-8804-68e361f9164f",
        "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
        "email": "jsmith@example.com",
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "name_service": {
          "avatar": "<string>",
          "name": "<string>"
        },
        "public_identifier": "<string>",
        "wallet_name": "<string>",
        "wallet_provider": "browserExtension",
        "wallet_properties": {
          "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isAuthenticatorAttached": true,
          "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isSessionKeyCompatible": true,
          "version": "V1",
          "ecdsaProviderType": "zerodev_signer_to_ecdsa",
          "entryPointVersion": "v6",
          "kernelVersion": "v2_4"
        },
        "format": "blockchain",
        "oauth_provider": "emailOnly",
        "oauth_username": "<string>",
        "oauth_display_name": "<string>",
        "oauth_account_id": "<string>",
        "phoneNumber": "9171113333",
        "phoneCountryCode": "1",
        "isoCountryCode": "US",
        "oauth_account_photos": [
          "<string>"
        ],
        "oauth_emails": [
          "<string>"
        ],
        "oauth_metadata": {},
        "previous_users": [
          "95b11417-f18f-457f-8804-68e361f9164f"
        ],
        "embedded_wallet_id": "<string>",
        "wallet_additional_addresses": [
          {
            "address": "<string>",
            "publicKey": "<string>",
            "type": "ordinals"
          }
        ],
        "lastSelectedAt": "2023-11-07T05:31:56Z",
        "signInEnabled": true
      }
    ],
    "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
    "alias": "An example name",
    "country": "US",
    "email": "jsmith@example.com",
    "firstName": "An example name",
    "jobTitle": "An example name",
    "lastName": "An example name",
    "phoneNumber": "<string>",
    "policiesConsent": true,
    "tShirtSize": "An example name",
    "team": "An example name",
    "username": "An example name",
    "firstVisit": "2023-11-07T05:31:56Z",
    "lastVisit": "2023-11-07T05:31:56Z",
    "newUser": true,
    "metadata": {},
    "mfaBackupCodeAcknowledgement": "pending",
    "btcWallet": "<string>",
    "kdaWallet": "<string>",
    "ltcWallet": "<string>",
    "ckbWallet": "<string>",
    "kasWallet": "<string>",
    "dogeWallet": "<string>",
    "emailNotification": true,
    "discordNotification": true,
    "newsletterNotification": true,
    "lists": [
      "<string>"
    ],
    "scope": "superuser marketing operations",
    "missingFields": [
      {
        "name": "<string>",
        "required": true,
        "enabled": true,
        "unique": true,
        "verify": true,
        "type": "standard",
        "validationRules": {
          "unique": true,
          "regex": "^0x",
          "validOptions": [
            {
              "label": "small"
            },
            {
              "label": "medium"
            },
            {
              "label": "large"
            }
          ],
          "checkboxText": "Agree to the terms and conditions"
        },
        "validationType": "text",
        "label": "<string>",
        "position": 123
      }
    ],
    "walletPublicKey": "<string>",
    "wallet": "<string>",
    "chain": "ETH",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "sessions": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "createdAt": "2023-11-07T05:31:56Z",
        "ipAddress": "<string>",
        "userAgent": "<string>",
        "revokedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "wallets": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "name": "An example name",
        "chain": "ETH",
        "publicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "provider": "browserExtension",
        "properties": {
          "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
          "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isAuthenticatorAttached": true,
          "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
          "isSessionKeyCompatible": true,
          "version": "V1",
          "ecdsaProviderType": "zerodev_signer_to_ecdsa",
          "entryPointVersion": "v6",
          "kernelVersion": "v2_4"
        },
        "lastSelectedAt": "<string>"
      }
    ],
    "chainalysisChecks": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "createdAt": "2023-11-07T05:31:56Z",
        "result": "OK",
        "walletPublicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "response": "<string>"
      }
    ],
    "oauthAccounts": [
      {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "provider": "emailOnly",
        "accountUsername": "<string>"
      }
    ],
    "mfaDevices": [
      {
        "type": "totp",
        "verified": true,
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "createdAt": "2023-11-07T05:31:56Z",
        "verifiedAt": "2023-11-07T05:31:56Z",
        "default": true,
        "alias": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json
User new fields data

User fields that can be updated on dashboard or through the rest API which do not involve any uniqueness checks or further verification

id
string
Required string length: 36
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

alias
string
Maximum length: 255
Example:

"An example name"

firstName
string
Maximum length: 255
Example:

"An example name"

lastName
string
Maximum length: 255
Example:

"An example name"

jobTitle
string
Maximum length: 255
Example:

"An example name"

phoneNumber
string
Maximum length: 255
Example:

"An example name"

metadata
object
mfaBackupCodeAcknowledgement
enum<string> | null
Available options:
pending,
complete
tShirtSize
string
Maximum length: 255
Example:

"An example name"

team
string
Maximum length: 255
Example:

"An example name"

country
string | null

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

Maximum length: 255
Example:

"US"

username
string | null

Alphanumeric with slugs and underscores username

Maximum length: 255
Example:

"johndoe"

btcWallet
string | null

BTC wallet address

Example:

"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"

kdaWallet
string | null

KDA wallet address

Example:

"k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"

ltcWallet
string | null

LTC wallet address

Example:

"LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax"

ckbWallet
string | null

CKB wallet address

Example:

"ckt1q9876543210abcdefghijklmnopqrstuvwxyz"

kasWallet
string | null

KAS wallet address

Example:

"kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m"

dogeWallet
string | null

DOGE wallet address

Example:

"DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB"

emailNotification
boolean
discordNotification
boolean
newsletterNotification
boolean
emailVerifiedAt
string

When provided, the user email will be marked as verified in our system and the user will be allowed to sign in with that email. When social is enabled and the social provider has a verified email, we will automatically associate that social with the existing user.

email
string

If email is trusted and verified, please provide a emailVerifiedAt timestamp. This will ensure that a user signing in with this email can access the correctly-created user account.

Maximum length: 255
Example:

"hello-world@foobar.com"

wallets
object[]
oauthAccounts
object[]

Response

201
application/json
Successfully created new user
user
object