Creates a new user

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": {},
  "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": "[email protected]",
  "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": [
        "[email protected]"
      ],
      "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": "[email protected]",
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "nameService": {
          "avatar": "<string>",
          "name": "<string>"
        },
        "publicIdentifier": "<string>",
        "walletName": "<string>",
        "walletProvider": "browserExtension",
        "walletProperties": {
          "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"
        },
        "format": "blockchain",
        "oauthProvider": "emailOnly",
        "oauthUsername": "<string>",
        "oauthDisplayName": "<string>",
        "oauthAccountId": "<string>",
        "phoneNumber": "9171113333",
        "phoneCountryCode": "1",
        "isoCountryCode": "US",
        "oauthAccountPhotos": [
          "<string>"
        ],
        "oauthEmails": [
          "<string>"
        ],
        "oauthMetadata": {},
        "previousUsers": [
          "95b11417-f18f-457f-8804-68e361f9164f"
        ],
        "embeddedWalletId": "<string>",
        "walletAdditionalAddresses": [
          {
            "address": "<string>",
            "publicKey": "<string>",
            "type": "ordinals"
          }
        ],
        "lastSelectedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
    "alias": "An example name",
    "country": "US",
    "email": "[email protected]",
    "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": {},
    "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>"
      }
    ],
    "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>",
        "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"
        }
      }
    ],
    "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"
      }
    ]
  }
}

Authorizations

Authorization

string

headerrequired

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

Path Parameters

environmentId

string

required

ID of the environment

Body

application/json

string

ID of the environment

alias

string

firstName

string

lastName

string

jobTitle

string

phoneNumber

string

metadata

object

tShirtSize

string

team

string

policiesConsent

boolean

country

string | null

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

username

string | null

Alphanumeric username

btcWallet

string | null

BTC wallet address

kdaWallet

string | null

KDA wallet address

ltcWallet

string | null

LTC wallet address

ckbWallet

string | null

CKB wallet address

kasWallet

string | null

KAS wallet address

dogeWallet

string | null

DOGE wallet address

emailNotification

boolean

discordNotification

boolean

newsletterNotification

boolean

emailVerifiedAt

string

wallets

object[]

oauthAccounts

object[]

Response

201 - application/json

user

object

user.id

string

required

ID of the environment

user.projectEnvironmentId

string

required

ID of the environment

user.verifiedCredentials

object[]

user.verifiedCredentials.address

string

Valid blockchain wallet address, must be an alphanumeric string without any special characters

user.verifiedCredentials.chain

string

user.verifiedCredentials.refId

string

ID of the environment

user.verifiedCredentials.signerRefId

string

ID of the environment

user.verifiedCredentials.email

string

user.verifiedCredentials.id

string

required

ID of the environment

user.verifiedCredentials.nameService

object

user.verifiedCredentials.publicIdentifier

string

This is used to publicly identify a verified credential in a human-friendly way. For example, this will be the email address if credential format=email.

user.verifiedCredentials.walletName

string

user.verifiedCredentials.walletProvider

enum<string>

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

user.verifiedCredentials.walletProperties

object

user.verifiedCredentials.format

enum<string>

required

Available options:

blockchain,

email,

oauth,

passkey,

phoneNumber

user.verifiedCredentials.oauthProvider

enum<string>

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

dynamic,

alchemy,

zerodev,

turnkey,

coinbaseWaas,

sms

user.verifiedCredentials.oauthUsername

string

user.verifiedCredentials.oauthDisplayName

string

user.verifiedCredentials.oauthAccountId

string

user.verifiedCredentials.phoneNumber

string

This field contains the phone number in the country. This could also contain the area code within a country.

user.verifiedCredentials.phoneCountryCode

string

This field contains the phone international country code. See https://countrycode.org/

user.verifiedCredentials.isoCountryCode

string

ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

user.verifiedCredentials.oauthAccountPhotos

string[]

user.verifiedCredentials.oauthEmails

string[]

user.verifiedCredentials.oauthMetadata

object

This object contains JSON metadata for a social-based verified credential. It may contain data about the user that does not fit into the other structured fields, and could include arbitrary fields about the user from the oauth provider's API.

user.verifiedCredentials.previousUsers

string[]

This will only be provided in the responses for GET /users/{userId}.Previous user IDs that owned this verified credential and was tranfered to the current user ID.

user.verifiedCredentials.embeddedWalletId

string | null

user.verifiedCredentials.walletAdditionalAddresses

object[]

user.verifiedCredentials.lastSelectedAt

string

This timestamp indicates the last time this verified wallet was either connected to the user account or selected to become the primary wallet on the account.

user.lastVerifiedCredentialId

string

ID of the environment

user.sessionId

string

ID of the environment

user.alias

string | null

user.country

string | null

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

user.email

string | null

user.firstName

string | null

user.jobTitle

string | null

user.lastName

string | null

user.phoneNumber

string | null

user.policiesConsent

boolean | null

user.tShirtSize

string | null

user.team

string | null

user.username

string | null

user.firstVisit

string

user.lastVisit

string

user.newUser

boolean

user.metadata

object

user.btcWallet

string | null

user.kdaWallet

string | null

user.ltcWallet

string | null

user.ckbWallet

string | null

user.kasWallet

string | null

user.dogeWallet

string | null

user.emailNotification

boolean | null

user.discordNotification

boolean | null

user.newsletterNotification

boolean | null

user.lists

string[]

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

user.scope

string

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

user.missingFields

object[]

user.walletPublicKey

string

user.wallet

string

user.chain

enum<string>

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC

user.createdAt

string

user.updatedAt

string

user.sessions

object[]

user.wallets

object[]

user.chainalysisChecks

object[]

user.oauthAccounts

object[]

Was this page helpful?

Creates many new users Delete user

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": {},
  "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": "[email protected]",
  "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": [
        "[email protected]"
      ],
      "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": "[email protected]",
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "nameService": {
          "avatar": "<string>",
          "name": "<string>"
        },
        "publicIdentifier": "<string>",
        "walletName": "<string>",
        "walletProvider": "browserExtension",
        "walletProperties": {
          "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"
        },
        "format": "blockchain",
        "oauthProvider": "emailOnly",
        "oauthUsername": "<string>",
        "oauthDisplayName": "<string>",
        "oauthAccountId": "<string>",
        "phoneNumber": "9171113333",
        "phoneCountryCode": "1",
        "isoCountryCode": "US",
        "oauthAccountPhotos": [
          "<string>"
        ],
        "oauthEmails": [
          "<string>"
        ],
        "oauthMetadata": {},
        "previousUsers": [
          "95b11417-f18f-457f-8804-68e361f9164f"
        ],
        "embeddedWalletId": "<string>",
        "walletAdditionalAddresses": [
          {
            "address": "<string>",
            "publicKey": "<string>",
            "type": "ordinals"
          }
        ],
        "lastSelectedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
    "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
    "alias": "An example name",
    "country": "US",
    "email": "[email protected]",
    "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": {},
    "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>"
      }
    ],
    "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>",
        "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"
        }
      }
    ],
    "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"
      }
    ]
  }
}

Rest API

Authorizations

Path Parameters

Body

Response