- Announcements
- System Status
- Introduction
- allowlists
- analytics
- chainalysis
- chains
- custom fields
- environments
- events
- exports
- externaljwt
- gates
- members
- organizations
- origins
- projects
- invites
- sdk views
- settings
- tokens
- sessions
- users
- wallets
- webhooks
- Schemas
- AccessOutcomeEnum
- AddDeeplinkUrlRequest
- Allowlist
- AllowlistEntriesResponse
- AllowlistEntry
- AnalyticsSessionsByDate
- AnalyticsVisitResponse
- AnalyticsWalletsBreakdownResponse
- AuthModeEnum
- AuthSettings
- AuthStorageEnum
- AuthenticatorTransportProtocol
- BadRequest
- BaseUser
- BillingSubscription
- BillingSubscriptionPeriod
- BillingSubscriptionPlanTypeEnum
- BulkUserCreateResponse
- ChainConfiguration
- ChainConfigurations
- ChainEnum
- ChainToken
- ChainTokensResponse
- ChainalysisCheck
- ChainalysisCheckResultEnum
- ChainalysisConfiguration
- CoinbaseMpcWalletProperties
- CompletePasskeyRecoveryRequest
- ConnectRequest
- CountryCode
- CreateEmbeddedWalletParams
- CreateEmbeddedWalletSpecificOpts
- CreateEmbeddedWalletsRequest
- CreateMfaToken
- CreateProjectResponse
- CreateTokenResponse
- CreateTurnkeyEmbeddedWalletSpecificOpts
- CreateUserEmbeddedWalletsFromFarcasterRequest
- CreateUserEmbeddedWalletsRequest
- CreateUserOauthRequest
- CreateWalletRequest
- Currency
- CurrencyType
- CustomField
- CustomFieldRequest
- CustomFieldType
- CustomFieldValidValue
- CustomFieldValidationRules
- CustomFieldsResponse
- CustomHostname
- CustomHostnameCreateRequest
- CustomHostnameStatusEnum
- CustomHostnameVerificationRecord
- CustomHostnameVerificationType
- CustomHostnamesResponse
- DeeplinkUrlResponse
- DeeplinkUrlsResponse
- DnsRecordType
- Duration
- DynamicJwt
- EmailProviderResponse
- EmailVerificationCreateRequest
- EmailVerificationCreateResponse
- EmailVerificationRetryRequest
- EmailVerificationVerifyRequest
- EmbeddedWalletAuthToken
- EmbeddedWalletAuthType
- EmbeddedWalletPasscodeClaimRequest
- EmbeddedWalletProviderEnum
- EmbeddedWalletSecret
- EmbeddedWalletSecretWithUpdatedJwt
- EmbeddedWalletSecurityMethod
- EncodedJwt
- EnvironmentEnum
- EnvironmentVisitorsResponse
- EnvironmentsResponse
- ErrorMessageWithCode
- Event
- EventType
- EventTypesResponse
- EventsResponse
- ExchangeRatesResponse
- Export
- ExportCreateRequest
- ExportCreateRequestFilter
- ExportEmbeddedWalletResponse
- ExportFormatEnum
- ExportModelEnum
- ExportStatusEnum
- ExportsResponse
- ExternalAuth
- ExternalAuthSigninRequest
- ExternalJwtCheckRequest
- ExternalJwtCheckResponse
- FarcasterSignInRequest
- Forbidden
- ForbiddenErrorPayload
- ForbiddenWithErrorAndPayload
- FrameworkSettings
- Gate
- GateCreateRequest
- GateRule
- GateRuleFilter
- GateRuleType
- GateUpdateRequest
- GatesResponse
- GetUserPasskeysResponse
- HCaptchaSettings
- HTTPSUrlOrSNSArn
- HardwareWalletEnum
- HardwareWalletProperties
- HealthcheckResponse
- HealthcheckStatus
- InitEmailAuthRequest
- InitEmailAuthResponse
- InitPasskeyRecoveryRequest
- InitPasskeyRecoveryResponse
- IntegrationSetting
- InternalServerError
- InternalUserFields
- Invite
- InviteConflictResponse
- InviteSendRequest
- InviteStatusEnum
- InviteUpdateRequest
- InvitesResponse
- JwksKey
- JwksResponse
- JwtBlockchainAccount
- JwtPayloadDeprecatedInfo
- JwtVerifiedCredential
- JwtVerifiedCredentialFormatEnum
- Key
- KeyResponse
- KycFieldType
- MFAAuthRecoveryDevicePostRequest
- MFAAuthTotpDevicePostRequest
- MFADevice
- MFADeviceType
- MFAGetDeviceResponse
- MFAGetRecoveryCodesResponse
- MFAListDevicesResponse
- MFARegenRecoveryCodesResponse
- MFARegisterTotpDeviceGetResponse
- MFARegisterTotpDevicePostRequest
- MFARegisterTotpDevicePostResponse
- MFASettings
- MFAUpdateDeviceRequest
- MemberResponse
- MemberRoleField
- MembershipEnvironmentIds
- MergeConflicts
- MergeUser
- MergeUserConflict
- MergeUserConflictResolution
- MergeUserConflictResolutions
- MethodNotAllowed
- MfaBackupCodeAcknowledgement
- MinifiedDynamicJwt
- MobileSettings
- NameService
- NameServiceData
- NativeCurrency
- Network
- NetworkConfiguration
- NetworkConfigurationResponse
- NextJsSettings
- NextViewEnum
- NonEmptyIsoCountryCode
- NonEmptyString
- NonEmptyStringWith255MaxLength
- NonEmptyUrl
- NonEmptyUrlWith255MaxLength
- NonceResponse
- NotFound
- OAuthCode
- OAuthError
- OauthProviderLoginUrl
- OauthProviderRequest
- OauthRedirectRequest
- OauthRedirectRequestIdToken
- OauthRedirectUri
- OauthRequest
- OauthResultRequest
- OauthResultResponse
- OauthResultStatus
- OnrampConfiguration
- OptionalHexString
- OptionalNonEmptyString
- OptionalNonEmptyStringWith255MaxLength
- OptionalNonEmptyUrl
- OptionalNonEmptyUrlWith255MaxLength
- OptionalNullableNonEmptyStringWith255MaxLength
- Organization
- OrganizationFields
- OrganizationMember
- OrganizationMembersResponse
- OrganizationMfaSettings
- OrganizationMfaSettingsResponse
- OrganizationRequest
- OrganizationResponse
- OrganizationsResponse
- OriginResponse
- OriginsResponse
- PasskeyRegistrationCredential
- PasskeyStorage
- PasswordSourceTypeEnum
- PasswordString
- PostAllowlistEntriesRequest
- PostAllowlistsRequest
- PostTokenFields
- PrefetchRequest
- Project
- ProjectEnvironment
- ProjectRequest
- ProjectSettings
- ProjectSettingsChains
- ProjectSettingsDesign
- ProjectSettingsDesignButton
- ProjectSettingsDesignModal
- ProjectSettingsDesignWidget
- ProjectSettingsGeneral
- ProjectSettingsGeneralApps
- ProjectSettingsKyc
- ProjectSettingsPrivacy
- ProjectSettingsSdk
- ProjectSettingsSecurity
- ProjectsResponse
- Provider
- ProviderAgreement
- ProviderCreateRequest
- ProviderEnum
- ProviderUpdateRequest
- ProviderUrl
- ProviderUrlsResponse
- ProvidersResponse
- PublishEvents
- ReactSettings
- RegisterSessionKeyRequest
- RoleEnum
- SdkSettingsRequest
- SdkUser
- SdkView
- SdkViewSection
- SdkViewSectionAlignment
- SdkViewSectionType
- SdkViewType
- SdkViewUpdateRequest
- SdkViewsResponse
- Session
- SignInProviderEnum
- SmsCountryCode
- SmsVerificationCreateRequest
- SmsVerificationCreateResponse
- SmsVerificationRetryRequest
- SmsVerificationVerifyRequest
- SocialSignInProvider
- SocialSignInProviderEnum
- SubscriptionAdvancedScopeEnum
- SubscriptionFreeScopeEnum
- SupportedOnrampsResponse
- SupportedSecurityMethod
- SupportedSecurityMethods
- TimeUnitEnum
- Token
- TokenAddress
- TokenBalance
- TokenCreatedBy
- TokenWithRaw
- TokensResponse
- TooManyRequests
- TurnkeySignedRequest
- TurnkeyStamp
- TurnkeyWalletProperties
- Unauthorized
- UnprocessableEntity
- UnprocessableEntityErrorCode
- UnprocessableEntityErrorPayload
- UpdateProjectRequest
- UpdateProjectResponse
- UpdateRecoveryEmailRequest
- UpdateSelfResponse
- UpdateUserPasskeyRequest
- User
- UserFields
- UserFilterableFieldsEnum
- UserIdentifierTypeEnum
- UserOauthAccessTokenResponse
- UserPasskey
- UserResponse
- UserSearchFilterParams
- UserWalletSelectionRequest
- UserWalletsResponse
- Username
- UsersResponse
- ValidCustomHostname
- ValidStringQueryParam
- VerifyRequest
- VerifyResponse
- VerifyUnlinkRequest
- Visitor
- VisitorFilterableFieldsEnum
- VisitorSearchFilterParams
- VisitorsResponse
- Wallet
- WalletAdditionalAddress
- WalletAddressType
- WalletProperties
- WalletProviderEnum
- WalletPublicKey
- Webhook
- WebhookCreateRequest
- WebhookMessage
- WebhookMessageRedeliveryResponse
- WebhookMessagesResponse
- WebhookUpdateRequest
- WebhooksResponse
- WhenToImplementEnum
- btcWalletString
- caip2
- captchaToken
- ckbWalletString
- deeplinkUrl
- dogeWalletString
- emailOrEmptyString
- kasWalletString
- kdaWalletString
- ltcWalletString
- oAuthAccount
- orderBy
- origin
- phoneNumberOrEmptyString
- sixDigitsVerificationToken
- uuid
Rest API
UnprocessableEntity
email_already_exists
, allowlist_already_exists
, allowlist_entry_already_exists
, reassign_wallet_error
, reassign_wallet_confirm
, members_cannot_delete_themself
, username_already_exists
, wrong_email_verification_token
, wrong_sms_verification_token
, invalid_email_verification
, invalid_sms_verification
, invalid_verification
, too_many_sms_verification_attempts
, too_many_email_verification_attempts
, too_many_verification_attempts
, organization_name_already_exists
, project_name_already_exists
, wallet_not_deployed
, email_verification_required
, phone_verification_required
, invite_address_required
, provider_not_available
, forbidden_unlink_request
, invalid_unlink_request
, too_many_api_tokens
, lock_timeout
, lock_too_many_attempts
, nft_token_gating_not_supported_for_chain
, empty_chain_name
, no_enabled_email_provider
, no_enabled_sms_provider
, invalid_key_export_url
, invalid_dynamic_props
, too_many_requests
, too_many_organizations_for_user
, too_many_projects_for_organization
, email_associated_with_different_provider
, user_has_already_account_with_email
, user_has_already_account_with_phone_number
, other_verify_failure
, email_tied_to_embedded_wallet
, invalid_invite
, social_account_already_exists
, invalid_email_address
, invalid_gate
, conflicting_embedded_wallet_providers
, invalid_user
, invalid_cors_origins
, invalid_mobile_deeplink_urls
, unauthorized_mobile_deeplink_url
, invalid_private_key_format
, invalid_embedded_wallet_settings
, wallet_not_support_passkey
, recovery_email_unavailable_or_invalid
, connect_error
, invalid_wallet_name
, invalid_wallet_address
, email_recovery_disabled
, no_compatible_wallet_service_enabled
, missing_aa_project_id
, linked_embedded_wallet
, invalid_mpc_environment
, invalid_regex
, repeated_options
, missing_phone_number_or_email
, duplicate_exists
, mfa_device_not_found
, mfa_invalid_code
, mfa_invalid_request
, invalid_phone
, gate_exists
, invalid_embedded_wallet_chains_configuration
, merge_accounts_confirmation
, merge_accounts_invalid
, invalid_wallet_id
, unable_to_fetch_balances
, cannot_switch_to_unique
, custom_field_data_not_unique
, metadata_size_exceeded
, invalid_custom_hostname
, blocked_user_cannot_transfer_wallet
, feature_not_enabled_in_suborg
, invalid_username
, invalid_external_auth
, invalid_chain_address_match
, invalid_update
, cannot_delete_last_project
Contains information which the integrating client of this API can use to tailor an experience to a customer to fix the underlying issue that triggered this error.
emailOnly
, magicLink
, apple
, bitbucket
, coinbasesocial
, discord
, facebook
, farcaster
, github
, gitlab
, google
, instagram
, linkedin
, microsoft
, twitch
, twitter
, blocto
, banxa
, dynamic
, alchemy
, zerodev
, telegram
, turnkey
, coinbaseWaas
, sms
emailOnly
, magicLink
, apple
, bitbucket
, coinbasesocial
, discord
, facebook
, farcaster
, github
, gitlab
, google
, instagram
, linkedin
, microsoft
, twitch
, twitter
, blocto
, banxa
, dynamic
, alchemy
, zerodev
, telegram
, turnkey
, coinbaseWaas
, sms
Contains information needed for the SDK to surface merge conflicts when attempting to merge information from one user to another
Valid blockchain wallet address, must be an alphanumeric string without any special characters
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.
browserExtension
, custodialService
, walletConnect
, qrCode
, deepLink
, embeddedWallet
, smartContractWallet
Whether or not the wallet has an authenticator (passkey, api key, etc) attached to it.
blockchain
, email
, oauth
, passkey
, phoneNumber
, externalUser
emailOnly
, magicLink
, apple
, bitbucket
, coinbasesocial
, discord
, facebook
, farcaster
, github
, gitlab
, google
, instagram
, linkedin
, microsoft
, twitch
, twitter
, blocto
, banxa
, dynamic
, alchemy
, zerodev
, telegram
, turnkey
, coinbaseWaas
, sms
This field contains the phone number in the country. This could also contain the area code within a country.
This field contains the phone international country code. See https://countrycode.org/
ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
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.
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.
An address associated with a wallet.
The public key associated with the address.
ordinals
, payment
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.
Standard ISO 3166-1 alpha-2 two-letter country code
pending
, complete
Access lists evaluated by Dynamic when considering access for the user.
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
standard
, custom
Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
The dropdown options for the select field
The text that will be displayed for the checkbox field
text
, checkbox
, select
standard
, custom
Optional validation rules for the custom field
If this field must be unique for every user in the environment
The regex pattern that the text field must match
The dropdown options for the select field
The text that will be displayed for the checkbox field
text
, checkbox
, select
Contains the current field value for the user.
Contains the current field value for the user.
Was this page helpful?