> ## Documentation Index
> Fetch the complete documentation index at: https://turnkey-0e7c1f5b-moeo-sync.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Get activity
> Get details about an activity.
export const EndpointPath = ({type, path}) => {
return
Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.
Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.
;
};
Unique identifier for a given organization.
Unique identifier for a given activity object.
A successful response returns the following fields:
activity field
Unique identifier for a given Activity object.
Unique identifier for a given Organization.
status field
Enum options: `ACTIVITY_STATUS_CREATED`, `ACTIVITY_STATUS_PENDING`, `ACTIVITY_STATUS_COMPLETED`, `ACTIVITY_STATUS_FAILED`, `ACTIVITY_STATUS_CONSENSUS_NEEDED`, `ACTIVITY_STATUS_REJECTED`
type field
Enum options: `ACTIVITY_TYPE_CREATE_API_KEYS`, `ACTIVITY_TYPE_CREATE_USERS`, `ACTIVITY_TYPE_CREATE_PRIVATE_KEYS`, `ACTIVITY_TYPE_SIGN_RAW_PAYLOAD`, `ACTIVITY_TYPE_CREATE_INVITATIONS`, `ACTIVITY_TYPE_ACCEPT_INVITATION`, `ACTIVITY_TYPE_CREATE_POLICY`, `ACTIVITY_TYPE_DISABLE_PRIVATE_KEY`, `ACTIVITY_TYPE_DELETE_USERS`, `ACTIVITY_TYPE_DELETE_API_KEYS`, `ACTIVITY_TYPE_DELETE_INVITATION`, `ACTIVITY_TYPE_DELETE_ORGANIZATION`, `ACTIVITY_TYPE_DELETE_POLICY`, `ACTIVITY_TYPE_CREATE_USER_TAG`, `ACTIVITY_TYPE_DELETE_USER_TAGS`, `ACTIVITY_TYPE_CREATE_ORGANIZATION`, `ACTIVITY_TYPE_SIGN_TRANSACTION`, `ACTIVITY_TYPE_APPROVE_ACTIVITY`, `ACTIVITY_TYPE_REJECT_ACTIVITY`, `ACTIVITY_TYPE_DELETE_AUTHENTICATORS`, `ACTIVITY_TYPE_CREATE_AUTHENTICATORS`, `ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG`, `ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS`, `ACTIVITY_TYPE_SET_PAYMENT_METHOD`, `ACTIVITY_TYPE_ACTIVATE_BILLING_TIER`, `ACTIVITY_TYPE_DELETE_PAYMENT_METHOD`, `ACTIVITY_TYPE_CREATE_POLICY_V2`, `ACTIVITY_TYPE_CREATE_POLICY_V3`, `ACTIVITY_TYPE_CREATE_API_ONLY_USERS`, `ACTIVITY_TYPE_UPDATE_ROOT_QUORUM`, `ACTIVITY_TYPE_UPDATE_USER_TAG`, `ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG`, `ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2`, `ACTIVITY_TYPE_CREATE_ORGANIZATION_V2`, `ACTIVITY_TYPE_CREATE_USERS_V2`, `ACTIVITY_TYPE_ACCEPT_INVITATION_V2`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2`, `ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS`, `ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2`, `ACTIVITY_TYPE_UPDATE_USER`, `ACTIVITY_TYPE_UPDATE_POLICY`, `ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3`, `ACTIVITY_TYPE_CREATE_WALLET`, `ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS`, `ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY`, `ACTIVITY_TYPE_RECOVER_USER`, `ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE`, `ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE`, `ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2`, `ACTIVITY_TYPE_SIGN_TRANSACTION_V2`, `ACTIVITY_TYPE_EXPORT_PRIVATE_KEY`, `ACTIVITY_TYPE_EXPORT_WALLET`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4`, `ACTIVITY_TYPE_EMAIL_AUTH`, `ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT`, `ACTIVITY_TYPE_INIT_IMPORT_WALLET`, `ACTIVITY_TYPE_IMPORT_WALLET`, `ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY`, `ACTIVITY_TYPE_IMPORT_PRIVATE_KEY`, `ACTIVITY_TYPE_CREATE_POLICIES`, `ACTIVITY_TYPE_SIGN_RAW_PAYLOADS`, `ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION`, `ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS`, `ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5`, `ACTIVITY_TYPE_OAUTH`, `ACTIVITY_TYPE_CREATE_API_KEYS_V2`, `ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION`, `ACTIVITY_TYPE_EMAIL_AUTH_V2`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6`, `ACTIVITY_TYPE_DELETE_PRIVATE_KEYS`, `ACTIVITY_TYPE_DELETE_WALLETS`, `ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2`, `ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION`, `ACTIVITY_TYPE_INIT_OTP_AUTH`, `ACTIVITY_TYPE_OTP_AUTH`, `ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7`, `ACTIVITY_TYPE_UPDATE_WALLET`, `ACTIVITY_TYPE_UPDATE_POLICY_V2`, `ACTIVITY_TYPE_CREATE_USERS_V3`, `ACTIVITY_TYPE_INIT_OTP_AUTH_V2`, `ACTIVITY_TYPE_INIT_OTP`, `ACTIVITY_TYPE_VERIFY_OTP`, `ACTIVITY_TYPE_OTP_LOGIN`, `ACTIVITY_TYPE_STAMP_LOGIN`, `ACTIVITY_TYPE_OAUTH_LOGIN`, `ACTIVITY_TYPE_UPDATE_USER_NAME`, `ACTIVITY_TYPE_UPDATE_USER_EMAIL`, `ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER`, `ACTIVITY_TYPE_INIT_FIAT_ON_RAMP`, `ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE`, `ACTIVITY_TYPE_DELETE_SMART_CONTRACT_INTERFACE`
intent field
createOrganizationIntent field
Human-readable name for an Organization.
The root user's email address.
rootAuthenticator field
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
id field
type field
Enum options: `public-key`
rawId field
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
response field
clientDataJson field
attestationObject field
transports field
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
clientExtensionResults field
appid field
appidExclude field
credProps field
rk field
Challenge presented for authentication purposes.
Unique identifier for the root user object.
createAuthenticatorsIntent field
A list of Authenticators.
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
id field
type field
Enum options: `public-key`
rawId field
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
response field
clientDataJson field
attestationObject field
transports field
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
clientExtensionResults field
appid field
appidExclude field
credProps field
rk field
Challenge presented for authentication purposes.
Unique identifier for a given User.
createUsersIntent field
A list of Users.
Human-readable name for a User.
The user's email address.
accessType field
Enum options: `ACCESS_TYPE_WEB`, `ACCESS_TYPE_API`, `ACCESS_TYPE_ALL`
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
id field
type field
Enum options: `public-key`
rawId field
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
response field
clientDataJson field
attestationObject field
transports field
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
clientExtensionResults field
appid field
appidExclude field
credProps field
rk field
Challenge presented for authentication purposes.
A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.
item field
createPrivateKeysIntent field
A list of Private Keys.
Human-readable name for a Private Key.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body.
item field
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
item field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
signRawPayloadIntent field
Unique identifier for a given Private Key.
Raw unsigned payload to be signed.
encoding field
Enum options: `PAYLOAD_ENCODING_HEXADECIMAL`, `PAYLOAD_ENCODING_TEXT_UTF8`, `PAYLOAD_ENCODING_EIP712`
hashFunction field
Enum options: `HASH_FUNCTION_NO_OP`, `HASH_FUNCTION_SHA256`, `HASH_FUNCTION_KECCAK256`, `HASH_FUNCTION_NOT_APPLICABLE`
createInvitationsIntent field
A list of Invitations.
The name of the intended Invitation recipient.
The email address of the intended Invitation recipient.
A list of tags assigned to the Invitation recipient. This field, if not needed, should be an empty array in your request body.
item field
accessType field
Enum options: `ACCESS_TYPE_WEB`, `ACCESS_TYPE_API`, `ACCESS_TYPE_ALL`
Unique identifier for the Sender of an Invitation.
acceptInvitationIntent field
Unique identifier for a given Invitation object.
Unique identifier for a given User.
authenticator field
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
id field
type field
Enum options: `public-key`
rawId field
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
response field
clientDataJson field
attestationObject field
transports field
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
authenticatorAttachment field
Enum options: `cross-platform`, `platform`
clientExtensionResults field
appid field
appidExclude field
credProps field
rk field
Challenge presented for authentication purposes.
createPolicyIntent field
Human-readable name for a Policy.
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
subject field
operator field
Enum options: `OPERATOR_EQUAL`, `OPERATOR_MORE_THAN`, `OPERATOR_MORE_THAN_OR_EQUAL`, `OPERATOR_LESS_THAN`, `OPERATOR_LESS_THAN_OR_EQUAL`, `OPERATOR_CONTAINS`, `OPERATOR_NOT_EQUAL`, `OPERATOR_IN`, `OPERATOR_NOT_IN`, `OPERATOR_CONTAINS_ONE`, `OPERATOR_CONTAINS_ALL`
target field
effect field
Enum options: `EFFECT_ALLOW`, `EFFECT_DENY`
notes field
disablePrivateKeyIntent field
Unique identifier for a given Private Key.
deleteUsersIntent field
A list of User IDs.
item field
deleteAuthenticatorsIntent field
Unique identifier for a given User.
A list of Authenticator IDs.
item field
deleteInvitationIntent field
Unique identifier for a given Invitation object.
deleteOrganizationIntent field
Unique identifier for a given Organization.
deletePolicyIntent field
Unique identifier for a given Policy.
createUserTagIntent field
Human-readable name for a User Tag.
A list of User IDs.
item field
deleteUserTagsIntent field
A list of User Tag IDs.
item field
signTransactionIntent field
Unique identifier for a given Private Key.
Raw unsigned transaction to be signed by a particular Private Key.
type field
Enum options: `TRANSACTION_TYPE_ETHEREUM`, `TRANSACTION_TYPE_SOLANA`, `TRANSACTION_TYPE_TRON`
createApiKeysIntent field
A list of API Keys.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
Unique identifier for a given User.
deleteApiKeysIntent field
Unique identifier for a given User.
A list of API Key IDs.
item field
approveActivityIntent field
An artifact verifying a User's action.
rejectActivityIntent field
An artifact verifying a User's action.
createPrivateKeyTagIntent field
Human-readable name for a Private Key Tag.
A list of Private Key IDs.
item field
deletePrivateKeyTagsIntent field
A list of Private Key Tag IDs.
item field
createPolicyIntentV2 field
Human-readable name for a Policy.
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
subject field
operator field
Enum options: `OPERATOR_EQUAL`, `OPERATOR_MORE_THAN`, `OPERATOR_MORE_THAN_OR_EQUAL`, `OPERATOR_LESS_THAN`, `OPERATOR_LESS_THAN_OR_EQUAL`, `OPERATOR_CONTAINS`, `OPERATOR_NOT_EQUAL`, `OPERATOR_IN`, `OPERATOR_NOT_IN`, `OPERATOR_CONTAINS_ONE`, `OPERATOR_CONTAINS_ALL`
targets field
item field
effect field
Enum options: `EFFECT_ALLOW`, `EFFECT_DENY`
notes field
setPaymentMethodIntent field
The account number of the customer's credit card.
The verification digits of the customer's credit card.
The month that the credit card expires.
The year that the credit card expires.
The email that will receive invoices for the credit card.
The name associated with the credit card.
activateBillingTierIntent field
The product that the customer wants to subscribe to.
deletePaymentMethodIntent field
The payment method that the customer wants to remove.
createPolicyIntentV3 field
Human-readable name for a Policy.
effect field
Enum options: `EFFECT_ALLOW`, `EFFECT_DENY`
The condition expression that triggers the Effect
The consensus expression that triggers the Effect
notes field
createApiOnlyUsersIntent field
A list of API-only Users to create.
The name of the new API-only User.
The email address for this API-only User (optional).
A list of tags assigned to the new API-only User. This field, if not needed, should be an empty array in your request body.
item field
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
updateRootQuorumIntent field
The threshold of unique approvals to reach quorum.
The unique identifiers of users who comprise the quorum set.
item field
updateUserTagIntent field
Unique identifier for a given User Tag.
The new, human-readable name for the tag with the given ID.
A list of User IDs to add this tag to.
item field
A list of User IDs to remove this tag from.
item field
updatePrivateKeyTagIntent field
Unique identifier for a given Private Key Tag.
The new, human-readable name for the tag with the given ID.
A list of Private Keys IDs to add this tag to.
item field
A list of Private Key IDs to remove this tag from.
item field
createAuthenticatorsIntentV2 field
A list of Authenticators.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
Unique identifier for a given User.
acceptInvitationIntentV2 field
Unique identifier for a given Invitation object.
Unique identifier for a given User.
authenticator field
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
createOrganizationIntentV2 field
Human-readable name for an Organization.
The root user's email address.
rootAuthenticator field
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
Unique identifier for the root user object.
createUsersIntentV2 field
A list of Users.
Human-readable name for a User.
The user's email address.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.
item field
createSubOrganizationIntent field
Name for this sub-organization
rootAuthenticator field
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
createSubOrganizationIntentV2 field
Name for this sub-organization
Root users to create within this sub-organization
Human-readable name for a User.
The user's email address.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
updateAllowedOriginsIntent field
Additional origins requests are allowed from besides Turnkey origins
item field
createPrivateKeysIntentV2 field
A list of Private Keys.
Human-readable name for a Private Key.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body.
item field
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
item field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
updateUserIntent field
Unique identifier for a given User.
Human-readable name for a User.
The user's email address.
An updated list of User Tags to apply to this User. This field, if not needed, should be an empty array in your request body.
item field
The user's phone number in E.164 format e.g. +13214567890
updatePolicyIntent field
Unique identifier for a given Policy.
Human-readable name for a Policy.
policyEffect field
Enum options: `EFFECT_ALLOW`, `EFFECT_DENY`
The condition expression that triggers the Effect (optional).
The consensus expression that triggers the Effect (optional).
Accompanying notes for a Policy (optional).
setPaymentMethodIntentV2 field
The id of the payment method that was created clientside.
The email that will receive invoices for the credit card.
The name associated with the credit card.
createSubOrganizationIntentV3 field
Name for this sub-organization
Root users to create within this sub-organization
Human-readable name for a User.
The user's email address.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
A list of Private Keys.
Human-readable name for a Private Key.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body.
item field
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
item field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
createWalletIntent field
Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
createWalletAccountsIntent field
Unique identifier for a given Wallet.
A list of wallet Accounts.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
initUserEmailRecoveryIntent field
Email of the user starting recovery
Client-side public key generated by the user, to which the recovery bundle will be encrypted.
Expiration window (in seconds) indicating how long the recovery credential is valid for. If not provided, a default of 15 minutes will be used.
emailCustomization field
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
recoverUserIntent field
authenticator field
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
Unique identifier for the user performing recovery.
setOrganizationFeatureIntent field
name field
Enum options: `FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY`, `FEATURE_NAME_WEBAUTHN_ORIGINS`, `FEATURE_NAME_EMAIL_AUTH`, `FEATURE_NAME_EMAIL_RECOVERY`, `FEATURE_NAME_WEBHOOK`, `FEATURE_NAME_SMS_AUTH`, `FEATURE_NAME_OTP_EMAIL_AUTH`
Optional value for the feature. Will override existing values if feature is already set.
removeOrganizationFeatureIntent field
name field
Enum options: `FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY`, `FEATURE_NAME_WEBAUTHN_ORIGINS`, `FEATURE_NAME_EMAIL_AUTH`, `FEATURE_NAME_EMAIL_RECOVERY`, `FEATURE_NAME_WEBHOOK`, `FEATURE_NAME_SMS_AUTH`, `FEATURE_NAME_OTP_EMAIL_AUTH`
signRawPayloadIntentV2 field
A Wallet account address, Private Key address, or Private Key identifier.
Raw unsigned payload to be signed.
encoding field
Enum options: `PAYLOAD_ENCODING_HEXADECIMAL`, `PAYLOAD_ENCODING_TEXT_UTF8`, `PAYLOAD_ENCODING_EIP712`
hashFunction field
Enum options: `HASH_FUNCTION_NO_OP`, `HASH_FUNCTION_SHA256`, `HASH_FUNCTION_KECCAK256`, `HASH_FUNCTION_NOT_APPLICABLE`
signTransactionIntentV2 field
A Wallet account address, Private Key address, or Private Key identifier.
Raw unsigned transaction to be signed
type field
Enum options: `TRANSACTION_TYPE_ETHEREUM`, `TRANSACTION_TYPE_SOLANA`, `TRANSACTION_TYPE_TRON`
exportPrivateKeyIntent field
Unique identifier for a given Private Key.
Client-side public key generated by the user, to which the export bundle will be encrypted.
exportWalletIntent field
Unique identifier for a given Wallet.
Client-side public key generated by the user, to which the export bundle will be encrypted.
language field
Enum options: `MNEMONIC_LANGUAGE_ENGLISH`, `MNEMONIC_LANGUAGE_SIMPLIFIED_CHINESE`, `MNEMONIC_LANGUAGE_TRADITIONAL_CHINESE`, `MNEMONIC_LANGUAGE_CZECH`, `MNEMONIC_LANGUAGE_FRENCH`, `MNEMONIC_LANGUAGE_ITALIAN`, `MNEMONIC_LANGUAGE_JAPANESE`, `MNEMONIC_LANGUAGE_KOREAN`, `MNEMONIC_LANGUAGE_SPANISH`
createSubOrganizationIntentV4 field
Name for this sub-organization
Root users to create within this sub-organization
Human-readable name for a User.
The user's email address.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
wallet field
Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
emailAuthIntent field
Email of the authenticating user.
Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Email Auth - \
Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
emailCustomization field
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
Invalidate all other previously generated Email Auth API keys
Optional custom email address from which to send the email
Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
Optional custom email address to use as reply-to
exportWalletAccountIntent field
Address to identify Wallet Account.
Client-side public key generated by the user, to which the export bundle will be encrypted.
initImportWalletIntent field
The ID of the User importing a Wallet.
importWalletIntent field
The ID of the User importing a Wallet.
Human-readable name for a Wallet.
Bundle containing a wallet mnemonic encrypted to the enclave's target public key.
A list of wallet Accounts.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
initImportPrivateKeyIntent field
The ID of the User importing a Private Key.
importPrivateKeyIntent field
The ID of the User importing a Private Key.
Human-readable name for a Private Key.
Bundle containing a raw private key encrypted to the enclave's target public key.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
item field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
createPoliciesIntent field
An array of policy intents to be created.
Human-readable name for a Policy.
effect field
Enum options: `EFFECT_ALLOW`, `EFFECT_DENY`
The condition expression that triggers the Effect
The consensus expression that triggers the Effect
notes field
signRawPayloadsIntent field
A Wallet account address, Private Key address, or Private Key identifier.
An array of raw unsigned payloads to be signed.
item field
encoding field
Enum options: `PAYLOAD_ENCODING_HEXADECIMAL`, `PAYLOAD_ENCODING_TEXT_UTF8`, `PAYLOAD_ENCODING_EIP712`
hashFunction field
Enum options: `HASH_FUNCTION_NO_OP`, `HASH_FUNCTION_SHA256`, `HASH_FUNCTION_KECCAK256`, `HASH_FUNCTION_NOT_APPLICABLE`
createReadOnlySessionIntent field
createOauthProvidersIntent field
The ID of the User to add an Oauth provider to
A list of Oauth providers.
Human-readable name to identify a Provider.
Base64 encoded OIDC token
deleteOauthProvidersIntent field
The ID of the User to remove an Oauth provider from
Unique identifier for a given Provider.
item field
createSubOrganizationIntentV5 field
Name for this sub-organization
Root users to create within this sub-organization
Human-readable name for a User.
The user's email address.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
Human-readable name to identify a Provider.
Base64 encoded OIDC token
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
wallet field
Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
oauthIntent field
Base64 encoded OIDC token
Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Oauth - \
Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated Oauth API keys
createApiKeysIntentV2 field
A list of API Keys.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
curveType field
Enum options: `API_KEY_CURVE_P256`, `API_KEY_CURVE_SECP256K1`, `API_KEY_CURVE_ED25519`
Optional window (in seconds) indicating how long the API Key should last.
Unique identifier for a given User.
createReadWriteSessionIntent field
Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted.
Email of the user to create a read write session for
Optional human-readable name for an API Key. If none provided, default to Read Write Session - \
Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
emailAuthIntentV2 field
Email of the authenticating user.
Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Email Auth - \
Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
emailCustomization field
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
Invalidate all other previously generated Email Auth API keys
Optional custom email address from which to send the email
Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
Optional custom email address to use as reply-to
createSubOrganizationIntentV6 field
Name for this sub-organization
Root users to create within this sub-organization
Human-readable name for a User.
The user's email address.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
curveType field
Enum options: `API_KEY_CURVE_P256`, `API_KEY_CURVE_SECP256K1`, `API_KEY_CURVE_ED25519`
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
Human-readable name to identify a Provider.
Base64 encoded OIDC token
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
wallet field
Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
deletePrivateKeysIntent field
List of unique identifiers for private keys within an organization
item field
Optional parameter for deleting the private keys, even if any have not been previously exported. If they have been exported, this field is ignored.
deleteWalletsIntent field
List of unique identifiers for wallets within an organization
item field
Optional parameter for deleting the wallets, even if any have not been previously exported. If they have been exported, this field is ignored.
createReadWriteSessionIntentV2 field
Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted.
Unique identifier for a given User.
Optional human-readable name for an API Key. If none provided, default to Read Write Session - \
Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated ReadWriteSession API keys
deleteSubOrganizationIntent field
Sub-organization deletion, by default, requires associated wallets and private keys to be exported for security reasons. Set this boolean to true to force sub-organization deletion even if some wallets or private keys within it have not been exported yet. Default: false.
initOtpAuthIntent field
Enum to specifiy whether to send OTP via SMS or email
Email or phone number to send the OTP code to
emailCustomization field
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
smsCustomization field
Template containing references to .OtpCode i.e Your OTP is \{\{.OtpCode}}
Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address.
Optional custom email address from which to send the OTP email
Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
Optional custom email address to use as reply-to
otpAuthIntent field
ID representing the result of an init OTP activity.
OTP sent out to a user's contact (email or SMS)
Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to OTP Auth - \
Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated OTP Auth API keys
createSubOrganizationIntentV7 field
Name for this sub-organization
Root users to create within this sub-organization
Human-readable name for a User.
The user's email address.
The user's phone number in E.164 format e.g. +13214567890
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
curveType field
Enum options: `API_KEY_CURVE_P256`, `API_KEY_CURVE_SECP256K1`, `API_KEY_CURVE_ED25519`
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
Human-readable name to identify a Provider.
Base64 encoded OIDC token
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
wallet field
Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
curve field
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`
pathFormat field
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
addressFormat field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
Disable OTP SMS auth for the sub-organization
Disable OTP email auth for the sub-organization
updateWalletIntent field
Unique identifier for a given Wallet.
Human-readable name for a Wallet.
updatePolicyIntentV2 field
Unique identifier for a given Policy.
Human-readable name for a Policy.
policyEffect field
Enum options: `EFFECT_ALLOW`, `EFFECT_DENY`
The condition expression that triggers the Effect (optional).
The consensus expression that triggers the Effect (optional).
Accompanying notes for a Policy (optional).
createUsersIntentV3 field
A list of Users.
Human-readable name for a User.
The user's email address.
The user's phone number in E.164 format e.g. +13214567890
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
curveType field
Enum options: `API_KEY_CURVE_P256`, `API_KEY_CURVE_SECP256K1`, `API_KEY_CURVE_ED25519`
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
The type of authenticator transports.
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
Human-readable name to identify a Provider.
Base64 encoded OIDC token
A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.
item field
initOtpAuthIntentV2 field
Enum to specifiy whether to send OTP via SMS or email
Email or phone number to send the OTP code to
Optional length of the OTP code. Default = 9
emailCustomization field
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
smsCustomization field
Template containing references to .OtpCode i.e Your OTP is \{\{.OtpCode}}
Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address.
Optional custom email address from which to send the OTP email
Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true
Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
Optional custom email address to use as reply-to
initOtpIntent field
Whether to send OTP via SMS or email. Possible values: OTP\_TYPE\_SMS, OTP\_TYPE\_EMAIL
Email or phone number to send the OTP code to
Optional length of the OTP code. Default = 9
emailCustomization field
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
smsCustomization field
Template containing references to .OtpCode i.e Your OTP is \{\{.OtpCode}}
Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address.
Optional custom email address from which to send the OTP email
Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true
Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
Expiration window (in seconds) indicating how long the OTP is valid for. If not provided, a default of 5 minutes will be used. Maximum value is 600 seconds (10 minutes)
Optional custom email address to use as reply-to
verifyOtpIntent field
ID representing the result of an init OTP activity.
OTP sent out to a user's contact (email or SMS)
Expiration window (in seconds) indicating how long the verification token is valid for. If not provided, a default of 1 hour will be used. Maximum value is 86400 seconds (24 hours)
otpLoginIntent field
Signed JWT containing a unique id, expiry, verification type, contact
Client-side public key generated by the user, which will be conditionally added to org data based on the validity of the verification token
Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated Login API keys
stampLoginIntent field
Client-side public key generated by the user, which will be conditionally added to org data based on the passkey stamp associated with this request
Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated Login API keys
oauthLoginIntent field
Base64 encoded OIDC token
Client-side public key generated by the user, which will be conditionally added to org data based on the validity of the oidc token associated with this request
Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated Login API keys
updateUserNameIntent field
Unique identifier for a given User.
Human-readable name for a User.
updateUserEmailIntent field
Unique identifier for a given User.
The user's email address. Setting this to an empty string will remove the user's email.
Signed JWT containing a unique id, expiry, verification type, contact
updateUserPhoneNumberIntent field
Unique identifier for a given User.
The user's phone number in E.164 format e.g. +13214567890. Setting this to an empty string will remove the user's phone number.
Signed JWT containing a unique id, expiry, verification type, contact
initFiatOnRampIntent field
onrampProvider field
Enum options: `FIAT_ON_RAMP_PROVIDER_COINBASE`, `FIAT_ON_RAMP_PROVIDER_MOONPAY`
Destination wallet address for the buy transaction.
network field
Enum options: `FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN`, `FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM`, `FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA`, `FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE`
cryptoCurrencyCode field
Enum options: `FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC`, `FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH`, `FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL`, `FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC`
fiatCurrencyCode field
Enum options: `FIAT_ON_RAMP_CURRENCY_AUD`, `FIAT_ON_RAMP_CURRENCY_BGN`, `FIAT_ON_RAMP_CURRENCY_BRL`, `FIAT_ON_RAMP_CURRENCY_CAD`, `FIAT_ON_RAMP_CURRENCY_CHF`, `FIAT_ON_RAMP_CURRENCY_COP`, `FIAT_ON_RAMP_CURRENCY_CZK`, `FIAT_ON_RAMP_CURRENCY_DKK`, `FIAT_ON_RAMP_CURRENCY_DOP`, `FIAT_ON_RAMP_CURRENCY_EGP`, `FIAT_ON_RAMP_CURRENCY_EUR`, `FIAT_ON_RAMP_CURRENCY_GBP`, `FIAT_ON_RAMP_CURRENCY_HKD`, `FIAT_ON_RAMP_CURRENCY_IDR`, `FIAT_ON_RAMP_CURRENCY_ILS`, `FIAT_ON_RAMP_CURRENCY_JOD`, `FIAT_ON_RAMP_CURRENCY_KES`, `FIAT_ON_RAMP_CURRENCY_KWD`, `FIAT_ON_RAMP_CURRENCY_LKR`, `FIAT_ON_RAMP_CURRENCY_MXN`, `FIAT_ON_RAMP_CURRENCY_NGN`, `FIAT_ON_RAMP_CURRENCY_NOK`, `FIAT_ON_RAMP_CURRENCY_NZD`, `FIAT_ON_RAMP_CURRENCY_OMR`, `FIAT_ON_RAMP_CURRENCY_PEN`, `FIAT_ON_RAMP_CURRENCY_PLN`, `FIAT_ON_RAMP_CURRENCY_RON`, `FIAT_ON_RAMP_CURRENCY_SEK`, `FIAT_ON_RAMP_CURRENCY_THB`, `FIAT_ON_RAMP_CURRENCY_TRY`, `FIAT_ON_RAMP_CURRENCY_TWD`, `FIAT_ON_RAMP_CURRENCY_USD`, `FIAT_ON_RAMP_CURRENCY_VND`, `FIAT_ON_RAMP_CURRENCY_ZAR`
Specifies a preset fiat amount for the transaction, e.g., '100'. Must be greater than '20'. If not provided, the user will be prompted to enter an amount.
paymentMethod field
Enum options: `FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD`, `FIAT_ON_RAMP_PAYMENT_METHOD_APPLE_PAY`, `FIAT_ON_RAMP_PAYMENT_METHOD_GBP_BANK_TRANSFER`, `FIAT_ON_RAMP_PAYMENT_METHOD_GBP_OPEN_BANKING_PAYMENT`, `FIAT_ON_RAMP_PAYMENT_METHOD_GOOGLE_PAY`, `FIAT_ON_RAMP_PAYMENT_METHOD_SEPA_BANK_TRANSFER`, `FIAT_ON_RAMP_PAYMENT_METHOD_PIX_INSTANT_PAYMENT`, `FIAT_ON_RAMP_PAYMENT_METHOD_PAYPAL`, `FIAT_ON_RAMP_PAYMENT_METHOD_VENMO`, `FIAT_ON_RAMP_PAYMENT_METHOD_MOONPAY_BALANCE`, `FIAT_ON_RAMP_PAYMENT_METHOD_CRYPTO_ACCOUNT`, `FIAT_ON_RAMP_PAYMENT_METHOD_FIAT_WALLET`, `FIAT_ON_RAMP_PAYMENT_METHOD_ACH_BANK_ACCOUNT`
ISO 3166-1 two-digit country code for Coinbase representing the purchasing user’s country of residence, e.g., US, GB.
ISO 3166-2 two-digit country subdivision code for Coinbase representing the purchasing user’s subdivision of residence within their country, e.g. NY. Required if country\_code=US.
Optional flag to indicate whether to use the sandbox mode to simulate transactions for the on-ramp provider. Default is false.
createSmartContractInterfaceIntent field
Corresponding contract address or program ID
ABI/IDL as a JSON string
type field
Enum options: `SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM`, `SMART_CONTRACT_INTERFACE_TYPE_SOLANA`
Human-readable name for a Smart Contract Interface.
Notes for a Smart Contract Interface.
deleteSmartContractInterfaceIntent field
The ID of a Smart Contract Interface intended for deletion.
result field
createOrganizationResult field
Unique identifier for a given Organization.
createAuthenticatorsResult field
A list of Authenticator IDs.
item field
createUsersResult field
A list of User IDs.
item field
createPrivateKeysResult field
A list of Private Key IDs.
item field
createInvitationsResult field
A list of Invitation IDs
item field
acceptInvitationResult field
Unique identifier for a given Invitation.
Unique identifier for a given User.
signRawPayloadResult field
Component of an ECSDA signature.
Component of an ECSDA signature.
Component of an ECSDA signature.
createPolicyResult field
Unique identifier for a given Policy.
disablePrivateKeyResult field
Unique identifier for a given Private Key.
deleteUsersResult field
A list of User IDs.
item field
deleteAuthenticatorsResult field
Unique identifier for a given Authenticator.
item field
deleteInvitationResult field
Unique identifier for a given Invitation.
deleteOrganizationResult field
Unique identifier for a given Organization.
deletePolicyResult field
Unique identifier for a given Policy.
createUserTagResult field
Unique identifier for a given User Tag.
A list of User IDs.
item field
deleteUserTagsResult field
A list of User Tag IDs.
item field
A list of User IDs.
item field
signTransactionResult field
signedTransaction field
deleteApiKeysResult field
A list of API Key IDs.
item field
createApiKeysResult field
A list of API Key IDs.
item field
createPrivateKeyTagResult field
Unique identifier for a given Private Key Tag.
A list of Private Key IDs.
item field
deletePrivateKeyTagsResult field
A list of Private Key Tag IDs.
item field
A list of Private Key IDs.
item field
setPaymentMethodResult field
The last four digits of the credit card added.
The name associated with the payment method.
The email address associated with the payment method.
activateBillingTierResult field
The id of the product being subscribed to.
deletePaymentMethodResult field
The payment method that was removed.
createApiOnlyUsersResult field
A list of API-only User IDs.
item field
updateRootQuorumResult field
updateUserTagResult field
Unique identifier for a given User Tag.
updatePrivateKeyTagResult field
Unique identifier for a given Private Key Tag.
createSubOrganizationResult field
subOrganizationId field
rootUserIds field
item field
updateAllowedOriginsResult field
createPrivateKeysResultV2 field
A list of Private Key IDs and addresses.
privateKeyId field
addresses field
format field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
address field
updateUserResult field
A User ID.
updatePolicyResult field
Unique identifier for a given Policy.
createSubOrganizationResultV3 field
subOrganizationId field
A list of Private Key IDs and addresses.
privateKeyId field
addresses field
format field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
address field
rootUserIds field
item field
createWalletResult field
Unique identifier for a Wallet.
A list of account addresses.
item field
createWalletAccountsResult field
A list of derived addresses.
item field
initUserEmailRecoveryResult field
Unique identifier for the user being recovered.
recoverUserResult field
ID of the authenticator created.
item field
setOrganizationFeatureResult field
Resulting list of organization features.
name field
Enum options: `FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY`, `FEATURE_NAME_WEBAUTHN_ORIGINS`, `FEATURE_NAME_EMAIL_AUTH`, `FEATURE_NAME_EMAIL_RECOVERY`, `FEATURE_NAME_WEBHOOK`, `FEATURE_NAME_SMS_AUTH`, `FEATURE_NAME_OTP_EMAIL_AUTH`
value field
removeOrganizationFeatureResult field
Resulting list of organization features.
name field
Enum options: `FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY`, `FEATURE_NAME_WEBAUTHN_ORIGINS`, `FEATURE_NAME_EMAIL_AUTH`, `FEATURE_NAME_EMAIL_RECOVERY`, `FEATURE_NAME_WEBHOOK`, `FEATURE_NAME_SMS_AUTH`, `FEATURE_NAME_OTP_EMAIL_AUTH`
value field
exportPrivateKeyResult field
Unique identifier for a given Private Key.
Export bundle containing a private key encrypted to the client's target public key.
exportWalletResult field
Unique identifier for a given Wallet.
Export bundle containing a wallet mnemonic + optional newline passphrase encrypted by the client's target public key.
createSubOrganizationResultV4 field
subOrganizationId field
wallet field
walletId field
A list of account addresses.
item field
rootUserIds field
item field
emailAuthResult field
Unique identifier for the authenticating User.
Unique identifier for the created API key.
exportWalletAccountResult field
Address to identify Wallet Account.
Export bundle containing a private key encrypted by the client's target public key.
initImportWalletResult field
Import bundle containing a public key and signature to use for importing client data.
importWalletResult field
Unique identifier for a Wallet.
A list of account addresses.
item field
initImportPrivateKeyResult field
Import bundle containing a public key and signature to use for importing client data.
importPrivateKeyResult field
Unique identifier for a Private Key.
A list of addresses.
format field
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`
address field
createPoliciesResult field
A list of unique identifiers for the created policies.
item field
signRawPayloadsResult field
signatures field
Component of an ECSDA signature.
Component of an ECSDA signature.
Component of an ECSDA signature.
createReadOnlySessionResult field
Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.
Human-readable name for an Organization.
Unique identifier for a given User.
Human-readable name for a User.
String representing a read only session
UTC timestamp in seconds representing the expiry time for the read only session.
createOauthProvidersResult field
A list of unique identifiers for Oauth Providers
item field
deleteOauthProvidersResult field
A list of unique identifiers for Oauth Providers
item field
createSubOrganizationResultV5 field
subOrganizationId field
wallet field
walletId field
A list of account addresses.
item field
rootUserIds field
item field
oauthResult field
Unique identifier for the authenticating User.
Unique identifier for the created API key.
HPKE encrypted credential bundle
createReadWriteSessionResult field
Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.
Human-readable name for an Organization.
Unique identifier for a given User.
Human-readable name for a User.
Unique identifier for the created API key.
HPKE encrypted credential bundle
createSubOrganizationResultV6 field
subOrganizationId field
wallet field
walletId field
A list of account addresses.
item field
rootUserIds field
item field
deletePrivateKeysResult field
A list of private key unique identifiers that were removed
item field
deleteWalletsResult field
A list of wallet unique identifiers that were removed
item field
createReadWriteSessionResultV2 field
Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.
Human-readable name for an Organization.
Unique identifier for a given User.
Human-readable name for a User.
Unique identifier for the created API key.
HPKE encrypted credential bundle
deleteSubOrganizationResult field
Unique identifier of the sub organization that was removed
initOtpAuthResult field
Unique identifier for an OTP authentication
otpAuthResult field
Unique identifier for the authenticating User.
Unique identifier for the created API key.
HPKE encrypted credential bundle
createSubOrganizationResultV7 field
subOrganizationId field
wallet field
walletId field
A list of account addresses.
item field
rootUserIds field
item field
updateWalletResult field
A Wallet ID.
updatePolicyResultV2 field
Unique identifier for a given Policy.
initOtpAuthResultV2 field
Unique identifier for an OTP authentication
initOtpResult field
Unique identifier for an OTP authentication
verifyOtpResult field
Signed JWT containing a unique id, expiry, verification type, contact. Verification status of a user is updated when the token is consumed (in OTP\_LOGIN requests)
otpLoginResult field
Signed JWT containing an expiry, public key, session type, user id, and organization id
stampLoginResult field
Signed JWT containing an expiry, public key, session type, user id, and organization id
oauthLoginResult field
Signed JWT containing an expiry, public key, session type, user id, and organization id
updateUserNameResult field
Unique identifier of the User whose name was updated.
updateUserEmailResult field
Unique identifier of the User whose email was updated.
updateUserPhoneNumberResult field
Unique identifier of the User whose phone number was updated.
initFiatOnRampResult field
Unique URL for a given fiat on-ramp flow.
Unique identifier used to retrieve transaction statuses for a given fiat on-ramp flow.
createSmartContractInterfaceResult field
The ID of the created Smart Contract Interface.
deleteSmartContractInterfaceResult field
The ID of the deleted Smart Contract Interface.
A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
Unique identifier for a given Vote object.
Unique identifier for a given User.
user field
Unique identifier for a given User.
Human-readable name for a User.
The user's email address.
The user's phone number in E.164 format e.g. +13214567890
A list of Authenticator parameters.
Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).
item field
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
attestationType field
Identifier indicating the type of the Security Key.
Unique identifier for a WebAuthn credential.
The type of Authenticator device.
credential field
The public component of a cryptographic key pair used to sign messages and transactions.
type field
Enum options: `CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR`, `CREDENTIAL_TYPE_API_KEY_P256`, `CREDENTIAL_TYPE_RECOVER_USER_KEY_P256`, `CREDENTIAL_TYPE_API_KEY_SECP256K1`, `CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256`, `CREDENTIAL_TYPE_API_KEY_ED25519`, `CREDENTIAL_TYPE_OTP_AUTH_KEY_P256`, `CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256`, `CREDENTIAL_TYPE_OAUTH_KEY_P256`, `CREDENTIAL_TYPE_LOGIN`
Unique identifier for a given Authenticator.
Human-readable name for an Authenticator.
createdAt field
seconds field
nanos field
updatedAt field
seconds field
nanos field
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
credential field
The public component of a cryptographic key pair used to sign messages and transactions.
type field
Enum options: `CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR`, `CREDENTIAL_TYPE_API_KEY_P256`, `CREDENTIAL_TYPE_RECOVER_USER_KEY_P256`, `CREDENTIAL_TYPE_API_KEY_SECP256K1`, `CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256`, `CREDENTIAL_TYPE_API_KEY_ED25519`, `CREDENTIAL_TYPE_OTP_AUTH_KEY_P256`, `CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256`, `CREDENTIAL_TYPE_OAUTH_KEY_P256`, `CREDENTIAL_TYPE_LOGIN`
Unique identifier for a given API Key.
Human-readable name for an API Key.
createdAt field
seconds field
nanos field
updatedAt field
seconds field
nanos field
Optional window (in seconds) indicating how long the API Key should last.
A list of User Tag IDs.
item field
A list of Oauth Providers.
Unique identifier for an OAuth Provider
Human-readable name to identify a Provider.
The issuer of the token, typically a URL indicating the authentication server, e.g [https://accounts.google.com](https://accounts.google.com)
Expected audience ('aud' attribute of the signed token) which represents the app ID
Expected subject ('sub' attribute of the signed token) which represents the user ID
createdAt field
seconds field
nanos field
updatedAt field
seconds field
nanos field
createdAt field
seconds field
nanos field
updatedAt field
seconds field
nanos field
Unique identifier for a given Activity object.
selection field
Enum options: `VOTE_SELECTION_APPROVED`, `VOTE_SELECTION_REJECTED`
The raw message being signed within a Vote.
The public component of a cryptographic key pair used to sign messages and transactions.
The signature applied to a particular vote.
Method used to produce a signature.
createdAt field
seconds field
nanos field
An artifact verifying a User's action.
canApprove field
canReject field
createdAt field
seconds field
nanos field
updatedAt field
seconds field
nanos field
failure field
code field
message field
details field
@type field
```bash title="cURL"
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_activity \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: (see Authorizations)" \
--data '{
"organizationId": "",
"activityId": ""
}'
```
```javascript title="JavaScript"
import { Turnkey } from "@turnkey/sdk-server";
const turnkeyClient = new Turnkey({
apiBaseUrl: "https://api.turnkey.com",
apiPublicKey: process.env.API_PUBLIC_KEY!,
apiPrivateKey: process.env.API_PRIVATE_KEY!,
defaultOrganizationId: process.env.ORGANIZATION_ID!,
});
const response = await turnkeyClient.apiClient().getActivity({
organizationId: " (Unique identifier for a given organization.)",
activityId: " (Unique identifier for a given activity object.)"
});
```
```json 200
{
"activity": {
"id": "",
"organizationId": "",
"status": "",
"type": "",
"intent": {
"createOrganizationIntent": {
"organizationName": "",
"rootEmail": "",
"rootAuthenticator": {
"authenticatorName": "",
"userId": "",
"attestation": {
"id": "",
"type": "",
"rawId": "",
"authenticatorAttachment": "",
"response": {
"clientDataJson": "",
"attestationObject": "",
"transports": [
""
],
"authenticatorAttachment": ""
},
"clientExtensionResults": {
"appid": "",
"appidExclude": "",
"credProps": {
"rk": ""
}
}
},
"challenge": ""
},
"rootUserId": ""
}
},
"result": {
"createOrganizationResult": {
"organizationId": ""
},
"createAuthenticatorsResult": {
"authenticatorIds": [
""
]
},
"createUsersResult": {
"userIds": [
""
]
},
"createPrivateKeysResult": {
"privateKeyIds": [
""
]
},
"createInvitationsResult": {
"invitationIds": [
""
]
},
"acceptInvitationResult": {
"invitationId": "",
"userId": ""
},
"signRawPayloadResult": {
"r": "",
"s": "",
"v": ""
},
"createPolicyResult": {
"policyId": ""
},
"disablePrivateKeyResult": {
"privateKeyId": ""
},
"deleteUsersResult": {
"userIds": [
""
]
},
"deleteAuthenticatorsResult": {
"authenticatorIds": [
""
]
},
"deleteInvitationResult": {
"invitationId": ""
},
"deleteOrganizationResult": {
"organizationId": ""
},
"deletePolicyResult": {
"policyId": ""
},
"createUserTagResult": {
"userTagId": "",
"userIds": [
""
]
},
"deleteUserTagsResult": {
"userTagIds": [
""
],
"userIds": [
""
]
},
"signTransactionResult": {
"signedTransaction": ""
},
"deleteApiKeysResult": {
"apiKeyIds": [
""
]
},
"createApiKeysResult": {
"apiKeyIds": [
""
]
},
"createPrivateKeyTagResult": {
"privateKeyTagId": "",
"privateKeyIds": [
""
]
},
"deletePrivateKeyTagsResult": {
"privateKeyTagIds": [
""
],
"privateKeyIds": [
""
]
},
"setPaymentMethodResult": {
"lastFour": "",
"cardHolderName": "",
"cardHolderEmail": ""
},
"activateBillingTierResult": {
"productId": ""
},
"deletePaymentMethodResult": {
"paymentMethodId": ""
},
"createApiOnlyUsersResult": {
"userIds": [
""
]
},
"updateRootQuorumResult": "