Activities
- Overview
- Create API Keys
- Create Authenticators
- Create Invitations
- Create Oauth Providers
- Create Policies
- Create Policy
- Create Private Key Tag
- Create Private Keys
- Create Read Only Session
- Create Read Write Session
- Create Sub-Organization
- Create User Tag
- Create Users
- Create Wallet
- Create Wallet Accounts
- Delete API Keys
- Delete Authenticators
- Delete Invitation
- Delete Oauth Providers
- Delete Policy
- Delete Private Key Tags
- Delete Private Keys
- Delete Sub Organization
- Delete User Tags
- Delete Users
- Delete Wallets
- Export Private Key
- Export Wallet
- Export Wallet Account
- Import Private Key
- Import Wallet
- Init Email Recovery
- Init Import Private Key
- Init Import Wallet
- Init OTP auth
- Oauth
- OTP auth
- Perform Email Auth
- Recover a user
- Remove Organization Feature
- Set Organization Feature
- Sign Raw Payload
- Sign Raw Payloads
- Sign Transaction
- Update Policy
- Update Private Key Tag
- Update Root Quorum
- Update User
- Update User Tag
- Update Wallet
Queries
- Overview
- Get Activity
- Get API key
- Get API keys
- Get Authenticator
- Get Authenticators
- Get Configs
- Get Oauth providers
- Get Policy
- Get Private Key
- Get Suborgs
- Get User
- Get Verified Suborgs
- Get Wallet
- Get Wallet Account
- List Activities
- List Policies
- List Private Key Tags
- List Private Keys
- List User Tags
- List Users
- List Wallets
- List Wallets Accounts
- Who am I?
Get Activity
Get details about an Activity
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"activityId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<ACTIVITY_STATUS_CREATED>",
"type": "<ACTIVITY_TYPE_CREATE_API_KEYS>",
"intent": {
"createOrganizationIntent": {
"organizationName": "<string>",
"rootEmail": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
},
"rootUserId": "<string>"
},
"createAuthenticatorsIntent": {
"authenticators": [
{
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
],
"userId": "<string>"
},
"createUsersIntent": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"accessType": "<ACCESS_TYPE_WEB>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
],
"userTags": [
"<string_element>"
]
}
]
},
"createPrivateKeysIntent": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"signRawPayloadIntent": {
"privateKeyId": "<string>",
"payload": "<string>",
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"createInvitationsIntent": {
"invitations": [
{
"receiverUserName": "<string>",
"receiverUserEmail": "<string>",
"receiverUserTags": [
"<string_element>"
],
"accessType": "<ACCESS_TYPE_WEB>",
"senderUserId": "<string>"
}
]
},
"acceptInvitationIntent": {
"invitationId": "<string>",
"userId": "<string>",
"authenticator": {
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
},
"createPolicyIntent": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "<OPERATOR_EQUAL>",
"target": "<string>"
}
],
"effect": "<EFFECT_ALLOW>",
"notes": "<string>"
},
"disablePrivateKeyIntent": {
"privateKeyId": "<string>"
},
"deleteUsersIntent": {
"userIds": [
"<string_element>"
]
},
"deleteAuthenticatorsIntent": {
"userId": "<string>",
"authenticatorIds": [
"<string_element>"
]
},
"deleteInvitationIntent": {
"invitationId": "<string>"
},
"deleteOrganizationIntent": {
"organizationId": "<string>"
},
"deletePolicyIntent": {
"policyId": "<string>"
},
"createUserTagIntent": {
"userTagName": "<string>",
"userIds": [
"<string_element>"
]
},
"deleteUserTagsIntent": {
"userTagIds": [
"<string_element>"
]
},
"signTransactionIntent": {
"privateKeyId": "<string>",
"unsignedTransaction": "<string>",
"type": "<TRANSACTION_TYPE_ETHEREUM>"
},
"createApiKeysIntent": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"deleteApiKeysIntent": {
"userId": "<string>",
"apiKeyIds": [
"<string_element>"
]
},
"approveActivityIntent": {
"fingerprint": "<string>"
},
"rejectActivityIntent": {
"fingerprint": "<string>"
},
"createPrivateKeyTagIntent": {
"privateKeyTagName": "<string>",
"privateKeyIds": [
"<string_element>"
]
},
"deletePrivateKeyTagsIntent": {
"privateKeyTagIds": [
"<string_element>"
]
},
"createPolicyIntentV2": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "<OPERATOR_EQUAL>",
"targets": [
"<string_element>"
]
}
],
"effect": "<EFFECT_ALLOW>",
"notes": "<string>"
},
"setPaymentMethodIntent": {
"number": "<string>",
"cvv": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>",
"cardHolderEmail": "<string>",
"cardHolderName": "<string>"
},
"activateBillingTierIntent": {
"productId": "<string>"
},
"deletePaymentMethodIntent": {
"paymentMethodId": "<string>"
},
"createPolicyIntentV3": {
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
},
"createApiOnlyUsersIntent": {
"apiOnlyUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"userTags": [
"<string_element>"
],
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
]
}
]
},
"updateRootQuorumIntent": {
"threshold": 123,
"userIds": [
"<string_element>"
]
},
"updateUserTagIntent": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string_element>"
],
"removeUserIds": [
"<string_element>"
]
},
"updatePrivateKeyTagIntent": {
"privateKeyTagId": "<string>",
"newPrivateKeyTagName": "<string>",
"addPrivateKeyIds": [
"<string_element>"
],
"removePrivateKeyIds": [
"<string_element>"
]
},
"createAuthenticatorsIntentV2": {
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"userId": "<string>"
},
"acceptInvitationIntentV2": {
"invitationId": "<string>",
"userId": "<string>",
"authenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
},
"createOrganizationIntentV2": {
"organizationName": "<string>",
"rootEmail": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
},
"rootUserId": "<string>"
},
"createUsersIntentV2": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"userTags": [
"<string_element>"
]
}
]
},
"createSubOrganizationIntent": {
"name": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
},
"createSubOrganizationIntentV2": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123
},
"updateAllowedOriginsIntent": {
"allowedOrigins": [
"<string_element>"
]
},
"createPrivateKeysIntentV2": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"updateUserIntent": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string_element>"
],
"userPhoneNumber": "<string>"
},
"updatePolicyIntent": {
"policyId": "<string>",
"policyName": "<string>",
"policyEffect": "<EFFECT_ALLOW>",
"policyCondition": "<string>",
"policyConsensus": "<string>",
"policyNotes": "<string>"
},
"setPaymentMethodIntentV2": {
"paymentMethodId": "<string>",
"cardHolderEmail": "<string>",
"cardHolderName": "<string>"
},
"createSubOrganizationIntentV3": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123,
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"createWalletIntent": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"createWalletAccountsIntent": {
"walletId": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
]
},
"initUserEmailRecoveryIntent": {
"email": "<string>",
"targetPublicKey": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
}
},
"recoverUserIntent": {
"authenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
},
"userId": "<string>"
},
"setOrganizationFeatureIntent": {
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
},
"removeOrganizationFeatureIntent": {
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>"
},
"signRawPayloadIntentV2": {
"signWith": "<string>",
"payload": "<string>",
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"signTransactionIntentV2": {
"signWith": "<string>",
"unsignedTransaction": "<string>",
"type": "<TRANSACTION_TYPE_ETHEREUM>"
},
"exportPrivateKeyIntent": {
"privateKeyId": "<string>",
"targetPublicKey": "<string>"
},
"exportWalletIntent": {
"walletId": "<string>",
"targetPublicKey": "<string>",
"language": "<MNEMONIC_LANGUAGE_ENGLISH>"
},
"createSubOrganizationIntentV4": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"emailAuthIntent": {
"email": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"invalidateExisting": true,
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"exportWalletAccountIntent": {
"address": "<string>",
"targetPublicKey": "<string>"
},
"initImportWalletIntent": {
"userId": "<string>"
},
"importWalletIntent": {
"userId": "<string>",
"walletName": "<string>",
"encryptedBundle": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
]
},
"initImportPrivateKeyIntent": {
"userId": "<string>"
},
"importPrivateKeyIntent": {
"userId": "<string>",
"privateKeyName": "<string>",
"encryptedBundle": "<string>",
"curve": "<CURVE_SECP256K1>",
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
},
"createPoliciesIntent": {
"policies": [
{
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
}
]
},
"signRawPayloadsIntent": {
"signWith": "<string>",
"payloads": [
"<string_element>"
],
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"createReadOnlySessionIntent": "<object>",
"createOauthProvidersIntent": {
"userId": "<string>",
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
},
"deleteOauthProvidersIntent": {
"userId": "<string>",
"providerIds": [
"<string_element>"
]
},
"createSubOrganizationIntentV5": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"oauthIntent": {
"oidcToken": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"createApiKeysIntentV2": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"createReadWriteSessionIntent": {
"targetPublicKey": "<string>",
"email": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
},
"emailAuthIntentV2": {
"email": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"invalidateExisting": true,
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"createSubOrganizationIntentV6": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"deletePrivateKeysIntent": {
"privateKeyIds": [
"<string_element>"
],
"deleteWithoutExport": true
},
"deleteWalletsIntent": {
"walletIds": [
"<string_element>"
],
"deleteWithoutExport": true
},
"createReadWriteSessionIntentV2": {
"targetPublicKey": "<string>",
"userId": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"deleteSubOrganizationIntent": {
"deleteWithoutExport": true
},
"initOtpAuthIntent": {
"otpType": "<string>",
"contact": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"smsCustomization": {
"template": "<string>"
},
"userIdentifier": "<string>",
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"otpAuthIntent": {
"otpId": "<string>",
"otpCode": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"createSubOrganizationIntentV7": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true,
"disableSmsAuth": true,
"disableOtpEmailAuth": true
},
"updateWalletIntent": {
"walletId": "<string>",
"walletName": "<string>"
},
"updatePolicyIntentV2": {
"policyId": "<string>",
"policyName": "<string>",
"policyEffect": "<EFFECT_ALLOW>",
"policyCondition": "<string>",
"policyConsensus": "<string>",
"policyNotes": "<string>"
},
"createUsersIntentV3": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
],
"userTags": [
"<string_element>"
]
}
]
},
"initOtpAuthIntentV2": {
"otpType": "<string>",
"contact": "<string>",
"otpLength": 123,
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"smsCustomization": {
"template": "<string>"
},
"userIdentifier": "<string>",
"sendFromEmailAddress": "<string>",
"alphanumeric": true,
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
}
},
"result": {
"createOrganizationResult": {
"organizationId": "<string>"
},
"createAuthenticatorsResult": {
"authenticatorIds": [
"<string_element>"
]
},
"createUsersResult": {
"userIds": [
"<string_element>"
]
},
"createPrivateKeysResult": {
"privateKeyIds": [
"<string_element>"
]
},
"createInvitationsResult": {
"invitationIds": [
"<string_element>"
]
},
"acceptInvitationResult": {
"invitationId": "<string>",
"userId": "<string>"
},
"signRawPayloadResult": {
"r": "<string>",
"s": "<string>",
"v": "<string>"
},
"createPolicyResult": {
"policyId": "<string>"
},
"disablePrivateKeyResult": {
"privateKeyId": "<string>"
},
"deleteUsersResult": {
"userIds": [
"<string_element>"
]
},
"deleteAuthenticatorsResult": {
"authenticatorIds": [
"<string_element>"
]
},
"deleteInvitationResult": {
"invitationId": "<string>"
},
"deleteOrganizationResult": {
"organizationId": "<string>"
},
"deletePolicyResult": {
"policyId": "<string>"
},
"createUserTagResult": {
"userTagId": "<string>",
"userIds": [
"<string_element>"
]
},
"deleteUserTagsResult": {
"userTagIds": [
"<string_element>"
],
"userIds": [
"<string_element>"
]
},
"signTransactionResult": {
"signedTransaction": "<string>"
},
"deleteApiKeysResult": {
"apiKeyIds": [
"<string_element>"
]
},
"createApiKeysResult": {
"apiKeyIds": [
"<string_element>"
]
},
"createPrivateKeyTagResult": {
"privateKeyTagId": "<string>",
"privateKeyIds": [
"<string_element>"
]
},
"deletePrivateKeyTagsResult": {
"privateKeyTagIds": [
"<string_element>"
],
"privateKeyIds": [
"<string_element>"
]
},
"setPaymentMethodResult": {
"lastFour": "<string>",
"cardHolderName": "<string>",
"cardHolderEmail": "<string>"
},
"activateBillingTierResult": {
"productId": "<string>"
},
"deletePaymentMethodResult": {
"paymentMethodId": "<string>"
},
"createApiOnlyUsersResult": {
"userIds": [
"<string_element>"
]
},
"updateRootQuorumResult": "<object>",
"updateUserTagResult": {
"userTagId": "<string>"
},
"updatePrivateKeyTagResult": {
"privateKeyTagId": "<string>"
},
"createSubOrganizationResult": {
"subOrganizationId": "<string>",
"rootUserIds": [
"<string_element>"
]
},
"updateAllowedOriginsResult": "<object>",
"createPrivateKeysResultV2": {
"privateKeys": [
{
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
}
]
},
"updateUserResult": {
"userId": "<string>"
},
"updatePolicyResult": {
"policyId": "<string>"
},
"createSubOrganizationResultV3": {
"subOrganizationId": "<string>",
"privateKeys": [
{
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
}
],
"rootUserIds": [
"<string_element>"
]
},
"createWalletResult": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"createWalletAccountsResult": {
"addresses": [
"<string_element>"
]
},
"initUserEmailRecoveryResult": {
"userId": "<string>"
},
"recoverUserResult": {
"authenticatorId": [
"<string_element>"
]
},
"setOrganizationFeatureResult": {
"features": [
{
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
}
]
},
"removeOrganizationFeatureResult": {
"features": [
{
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
}
]
},
"exportPrivateKeyResult": {
"privateKeyId": "<string>",
"exportBundle": "<string>"
},
"exportWalletResult": {
"walletId": "<string>",
"exportBundle": "<string>"
},
"createSubOrganizationResultV4": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"emailAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>"
},
"exportWalletAccountResult": {
"address": "<string>",
"exportBundle": "<string>"
},
"initImportWalletResult": {
"importBundle": "<string>"
},
"importWalletResult": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"initImportPrivateKeyResult": {
"importBundle": "<string>"
},
"importPrivateKeyResult": {
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
},
"createPoliciesResult": {
"policyIds": [
"<string_element>"
]
},
"signRawPayloadsResult": {
"signatures": [
{
"r": "<string>",
"s": "<string>",
"v": "<string>"
}
]
},
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
},
"createOauthProvidersResult": {
"providerIds": [
"<string_element>"
]
},
"deleteOauthProvidersResult": {
"providerIds": [
"<string_element>"
]
},
"createSubOrganizationResultV5": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"oauthResult": {
"userId": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createReadWriteSessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createSubOrganizationResultV6": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"deletePrivateKeysResult": {
"privateKeyIds": [
"<string_element>"
]
},
"deleteWalletsResult": {
"walletIds": [
"<string_element>"
]
},
"createReadWriteSessionResultV2": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"deleteSubOrganizationResult": {
"subOrganizationUuid": "<string>"
},
"initOtpAuthResult": {
"otpId": "<string>"
},
"otpAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createSubOrganizationResultV7": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"updateWalletResult": {
"walletId": "<string>"
},
"updatePolicyResultV2": {
"policyId": "<string>"
},
"initOtpAuthResultV2": {
"otpId": "<string>"
}
},
"votes": [
{
"id": "<string>",
"userId": "<string>",
"user": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"authenticators": [
{
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"attestationType": "<string>",
"aaguid": "<string>",
"credentialId": "<string>",
"model": "<string>",
"credential": {
"publicKey": "<string>",
"type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
},
"authenticatorId": "<string>",
"authenticatorName": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"apiKeys": [
{
"credential": {
"publicKey": "<string>",
"type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
},
"apiKeyId": "<string>",
"apiKeyName": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"expirationSeconds": "<string>"
}
],
"userTags": [
"<string_element>"
],
"oauthProviders": [
{
"providerId": "<string>",
"providerName": "<string>",
"issuer": "<string>",
"audience": "<string>",
"subject": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
},
"activityId": "<string>",
"selection": "<VOTE_SELECTION_APPROVED>",
"message": "<string>",
"publicKey": "<string>",
"signature": "<string>",
"scheme": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"fingerprint": "<string>",
"canApprove": true,
"canReject": true,
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"failure": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}
}
}
}
Authorizations
Body
Unique identifier for a given Organization.
Unique identifier for a given Activity object.
Response
A successful response returns the following fields:
activity field
Show activity details
Show activity details
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
intent field
Show intent details
Show intent details
createOrganizationIntent field
Show createOrganizationIntent details
Show createOrganizationIntent details
Human-readable name for an Organization.
rootAuthenticator field
Show rootAuthenticator details
Show rootAuthenticator details
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
Show attestation details
Show attestation details
type field
Enum options: public-key
rawId field
authenticatorAttachment field
Enum options: cross-platform, platform
response field
Show response details
Show response details
clientDataJson field
attestationObject field
transports field
Show transports details
Show transports details
clientExtensionResults field
Show clientExtensionResults details
Show clientExtensionResults details
appid field
appidExclude field
createAuthenticatorsIntent field
Show createAuthenticatorsIntent details
Show createAuthenticatorsIntent details
A list of Authenticators.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
Show attestation details
Show attestation details
type field
Enum options: public-key
rawId field
authenticatorAttachment field
Enum options: cross-platform, platform
response field
Show response details
Show response details
clientDataJson field
attestationObject field
transports field
Show transports details
Show transports details
clientExtensionResults field
Show clientExtensionResults details
Show clientExtensionResults details
appid field
appidExclude field
createUsersIntent field
Show createUsersIntent details
Show createUsersIntent details
A list of Users.
Show users details
Show users details
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.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
Show attestation details
Show attestation details
type field
Enum options: public-key
authenticatorAttachment field
Enum options: cross-platform, platform
response field
Show response details
Show response details
clientDataJson field
attestationObject field
transports field
Show transports details
Show transports details
clientExtensionResults field
Show clientExtensionResults details
Show clientExtensionResults details
appid field
appidExclude field
createPrivateKeysIntent field
Show createPrivateKeysIntent details
Show createPrivateKeysIntent details
A list of Private Keys.
Show privateKeys details
Show privateKeys details
Human-readable name for a Private Key.
curve field
Enum options: CURVE_SECP256K1, CURVE_ED25519
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
Show addressFormats details
Show addressFormats details
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_XRP
signRawPayloadIntent field
Show signRawPayloadIntent details
Show signRawPayloadIntent details
Unique identifier for a given Private Key.
encoding field
Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8
createInvitationsIntent field
Show createInvitationsIntent details
Show createInvitationsIntent details
A list of Invitations.
Show invitations details
Show invitations details
The name of the intended Invitation recipient.
The email address of the intended Invitation recipient.
accessType field
Enum options: ACCESS_TYPE_WEB, ACCESS_TYPE_API, ACCESS_TYPE_ALL
acceptInvitationIntent field
Show acceptInvitationIntent details
Show acceptInvitationIntent details
Unique identifier for a given Invitation object.
authenticator field
Show authenticator details
Show authenticator details
Human-readable name for an Authenticator.
Unique identifier for a given User.
attestation field
Show attestation details
Show attestation details
type field
Enum options: public-key
authenticatorAttachment field
Enum options: cross-platform, platform
response field
Show response details
Show response details
clientDataJson field
attestationObject field
transports field
clientExtensionResults field
Show clientExtensionResults details
Show clientExtensionResults details
appid field
appidExclude field
createPolicyIntent field
Show createPolicyIntent details
Show createPolicyIntent details
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
Show selectors details
Show selectors details
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
effect field
Enum options: EFFECT_ALLOW, EFFECT_DENY
deleteAuthenticatorsIntent field
Show deleteAuthenticatorsIntent details
Show deleteAuthenticatorsIntent details
createUserTagIntent field
signTransactionIntent field
Show signTransactionIntent details
Show signTransactionIntent details
Unique identifier for a given Private Key.
Raw unsigned transaction to be signed by a particular Private Key.
createApiKeysIntent field
Show createApiKeysIntent details
Show createApiKeysIntent details
A list of API Keys.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
deleteApiKeysIntent field
createPrivateKeyTagIntent field
Show createPrivateKeyTagIntent details
Show createPrivateKeyTagIntent details
Human-readable name for a Private Key Tag.
createPolicyIntentV2 field
Show createPolicyIntentV2 details
Show createPolicyIntentV2 details
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
Show selectors details
Show selectors details
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
effect field
Enum options: EFFECT_ALLOW, EFFECT_DENY
setPaymentMethodIntent field
Show setPaymentMethodIntent details
Show setPaymentMethodIntent details
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.
createPolicyIntentV3 field
Show createPolicyIntentV3 details
Show createPolicyIntentV3 details
effect field
Enum options: EFFECT_ALLOW, EFFECT_DENY
The condition expression that triggers the Effect
The consensus expression that triggers the Effect
createApiOnlyUsersIntent field
Show createApiOnlyUsersIntent details
Show createApiOnlyUsersIntent details
A list of API-only Users to create.
Show apiOnlyUsers details
Show apiOnlyUsers details
The name of the new API-only User.
The email address for this API-only User (optional).
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
updateRootQuorumIntent field
Show updateRootQuorumIntent details
Show updateRootQuorumIntent details
The threshold of unique approvals to reach quorum.
updateUserTagIntent field
Show updateUserTagIntent details
Show updateUserTagIntent details
The new, human-readable name for the tag with the given ID.
updatePrivateKeyTagIntent field
Show updatePrivateKeyTagIntent details
Show updatePrivateKeyTagIntent details
Unique identifier for a given Private Key Tag.
The new, human-readable name for the tag with the given ID.
createAuthenticatorsIntentV2 field
Show createAuthenticatorsIntentV2 details
Show createAuthenticatorsIntentV2 details
A list of Authenticators.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
acceptInvitationIntentV2 field
Show acceptInvitationIntentV2 details
Show acceptInvitationIntentV2 details
Unique identifier for a given Invitation object.
authenticator field
Show authenticator details
Show authenticator details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
createOrganizationIntentV2 field
Show createOrganizationIntentV2 details
Show createOrganizationIntentV2 details
Human-readable name for an Organization.
rootAuthenticator field
Show rootAuthenticator details
Show rootAuthenticator details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
createUsersIntentV2 field
Show createUsersIntentV2 details
Show createUsersIntentV2 details
A list of Users.
Show users details
Show users details
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
createSubOrganizationIntent field
Show createSubOrganizationIntent details
Show createSubOrganizationIntent details
rootAuthenticator field
Show rootAuthenticator details
Show rootAuthenticator details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
createSubOrganizationIntentV2 field
Show createSubOrganizationIntentV2 details
Show createSubOrganizationIntentV2 details
Name for this sub-organization
Root users to create within this sub-organization
Show rootUsers details
Show rootUsers details
Human-readable name for a User.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
Show transports details
Show transports details
updateAllowedOriginsIntent field
createPrivateKeysIntentV2 field
Show createPrivateKeysIntentV2 details
Show createPrivateKeysIntentV2 details
A list of Private Keys.
Show privateKeys details
Show privateKeys details
Human-readable name for a Private Key.
curve field
Enum options: CURVE_SECP256K1, CURVE_ED25519
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
Show addressFormats details
Show addressFormats details
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_XRP
updateUserIntent field
Show updateUserIntent details
Show updateUserIntent details
updatePolicyIntent field
Show updatePolicyIntent details
Show updatePolicyIntent details
policyEffect field
Enum options: EFFECT_ALLOW, EFFECT_DENY
The condition expression that triggers the Effect (optional).
The consensus expression that triggers the Effect (optional).
setPaymentMethodIntentV2 field
Show setPaymentMethodIntentV2 details
Show setPaymentMethodIntentV2 details
The id of the payment method that was created clientside.
The email that will receive invoices for the credit card.
createSubOrganizationIntentV3 field
Show createSubOrganizationIntentV3 details
Show createSubOrganizationIntentV3 details
Name for this sub-organization
Root users to create within this sub-organization
Show rootUsers details
Show rootUsers details
Human-readable name for a User.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
Show transports details
Show transports details
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.
Show privateKeys details
Show privateKeys details
Human-readable name for a Private Key.
curve field
Enum options: CURVE_SECP256K1, CURVE_ED25519
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
Show addressFormats details
Show addressFormats details
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_XRP
createWalletIntent field
Show createWalletIntent details
Show createWalletIntent details
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
Show accounts details
Show accounts details
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_XRP
createWalletAccountsIntent field
Show createWalletAccountsIntent details
Show createWalletAccountsIntent details
Unique identifier for a given Wallet.
A list of wallet Accounts.
Show accounts details
Show accounts details
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_XRP
initUserEmailRecoveryIntent field
Show initUserEmailRecoveryIntent details
Show initUserEmailRecoveryIntent details
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. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show emailCustomization details
Show emailCustomization details
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.
recoverUserIntent field
Show recoverUserIntent details
Show recoverUserIntent details
authenticator field
Show authenticator details
Show authenticator details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
setOrganizationFeatureIntent field
Show setOrganizationFeatureIntent details
Show setOrganizationFeatureIntent details
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
removeOrganizationFeatureIntent field
Show removeOrganizationFeatureIntent details
Show removeOrganizationFeatureIntent details
signRawPayloadIntentV2 field
Show signRawPayloadIntentV2 details
Show signRawPayloadIntentV2 details
A Wallet account address, Private Key address, or Private Key identifier.
encoding field
Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8
signTransactionIntentV2 field
Show signTransactionIntentV2 details
Show signTransactionIntentV2 details
A Wallet account address, Private Key address, or Private Key identifier.
Raw unsigned transaction to be signed
exportPrivateKeyIntent field
Show exportPrivateKeyIntent details
Show exportPrivateKeyIntent details
exportWalletIntent field
Show exportWalletIntent details
Show exportWalletIntent details
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
Show createSubOrganizationIntentV4 details
Show createSubOrganizationIntentV4 details
Name for this sub-organization
Root users to create within this sub-organization
Show rootUsers details
Show rootUsers details
Human-readable name for a User.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
Show transports details
Show transports details
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
Show wallet details
Show wallet details
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.
Show accounts details
Show accounts details
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_XRP
Disable email recovery for the sub-organization
emailAuthIntent field
Show emailAuthIntent details
Show emailAuthIntent details
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 - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show emailCustomization details
Show emailCustomization details
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.
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’
exportWalletAccountIntent field
importWalletIntent field
Show importWalletIntent details
Show importWalletIntent details
Bundle containing a wallet mnemonic encrypted to the enclave’s target public key.
A list of wallet Accounts.
Show accounts details
Show accounts details
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_XRP
importPrivateKeyIntent field
Show importPrivateKeyIntent details
Show importPrivateKeyIntent details
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).
Show addressFormats details
Show addressFormats details
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_XRP
createPoliciesIntent field
Show createPoliciesIntent details
Show createPoliciesIntent details
An array of policy intents to be created.
Show policies details
Show policies details
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
signRawPayloadsIntent field
Show signRawPayloadsIntent details
Show signRawPayloadsIntent details
A Wallet account address, Private Key address, or Private Key identifier.
encoding field
Enum options: PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8
createOauthProvidersIntent field
Show createOauthProvidersIntent details
Show createOauthProvidersIntent details
The ID of the User to add an Oauth provider to
deleteOauthProvidersIntent field
Show deleteOauthProvidersIntent details
Show deleteOauthProvidersIntent details
The ID of the User to remove an Oauth provider from
createSubOrganizationIntentV5 field
Show createSubOrganizationIntentV5 details
Show createSubOrganizationIntentV5 details
Name for this sub-organization
Root users to create within this sub-organization
Show rootUsers details
Show rootUsers details
Human-readable name for a User.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
Show transports details
Show transports details
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
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
Show wallet details
Show wallet details
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.
Show accounts details
Show accounts details
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_XRP
Disable email recovery for the sub-organization
oauthIntent field
Show oauthIntent details
Show oauthIntent details
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 - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
createApiKeysIntentV2 field
Show createApiKeysIntentV2 details
Show createApiKeysIntentV2 details
A list of API Keys.
Show apiKeys details
Show apiKeys details
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
createReadWriteSessionIntent field
Show createReadWriteSessionIntent details
Show createReadWriteSessionIntent details
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 - <Timestamp>
emailAuthIntentV2 field
Show emailAuthIntentV2 details
Show emailAuthIntentV2 details
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 - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show emailCustomization details
Show emailCustomization details
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.
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’
createSubOrganizationIntentV6 field
Show createSubOrganizationIntentV6 details
Show createSubOrganizationIntentV6 details
Name for this sub-organization
Root users to create within this sub-organization
Show rootUsers details
Show rootUsers details
Human-readable name for a User.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
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
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
Show transports details
Show transports details
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
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
Show wallet details
Show wallet details
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.
Show accounts details
Show accounts details
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_XRP
Disable email recovery for the sub-organization
deletePrivateKeysIntent field
Show deletePrivateKeysIntent details
Show deletePrivateKeysIntent details
deleteWalletsIntent field
Show deleteWalletsIntent details
Show deleteWalletsIntent details
createReadWriteSessionIntentV2 field
Show createReadWriteSessionIntentV2 details
Show createReadWriteSessionIntentV2 details
Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Read Write Session - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
deleteSubOrganizationIntent field
Show deleteSubOrganizationIntent details
Show deleteSubOrganizationIntent details
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
Show initOtpAuthIntent details
Show initOtpAuthIntent details
Enum to specifiy whether to send OTP via SMS or email
Email or phone number to send the OTP code to
emailCustomization field
Show emailCustomization details
Show emailCustomization details
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.
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’
otpAuthIntent field
Show otpAuthIntent details
Show otpAuthIntent details
ID representing the result of an init OTP activity.
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 - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
createSubOrganizationIntentV7 field
Show createSubOrganizationIntentV7 details
Show createSubOrganizationIntentV7 details
Name for this sub-organization
Root users to create within this sub-organization
Show rootUsers details
Show rootUsers details
Human-readable name for a User.
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.
Show apiKeys details
Show apiKeys details
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
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
Show transports details
Show transports details
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
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
Show wallet details
Show wallet details
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.
Show accounts details
Show accounts details
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_XRP
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
Disable OTP SMS auth for the sub-organization
updatePolicyIntentV2 field
Show updatePolicyIntentV2 details
Show updatePolicyIntentV2 details
policyEffect field
Enum options: EFFECT_ALLOW, EFFECT_DENY
The condition expression that triggers the Effect (optional).
The consensus expression that triggers the Effect (optional).
createUsersIntentV3 field
Show createUsersIntentV3 details
Show createUsersIntentV3 details
A list of Users.
Show users details
Show users details
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.
Show apiKeys details
Show apiKeys details
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
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Show authenticators details
Show authenticators details
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
Show attestation details
Show attestation details
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.
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
initOtpAuthIntentV2 field
Show initOtpAuthIntentV2 details
Show initOtpAuthIntentV2 details
Enum to specifiy whether to send OTP via SMS or email
Email or phone number to send the OTP code to
emailCustomization field
Show emailCustomization details
Show emailCustomization details
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.
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’
result field
Show result details
Show result details
signRawPayloadResult field
deleteAuthenticatorsResult field
createUserTagResult field
deleteUserTagsResult field
Show deleteUserTagsResult details
Show deleteUserTagsResult details
createPrivateKeyTagResult field
Show createPrivateKeyTagResult details
Show createPrivateKeyTagResult details
Unique identifier for a given Private Key Tag.
deletePrivateKeyTagsResult field
Show deletePrivateKeyTagsResult details
Show deletePrivateKeyTagsResult details
setPaymentMethodResult field
Show setPaymentMethodResult details
Show setPaymentMethodResult details
The last four digits of the credit card added.
The name associated with the payment method.
createSubOrganizationResult field
Show createSubOrganizationResult details
Show createSubOrganizationResult details
createPrivateKeysResultV2 field
Show createPrivateKeysResultV2 details
Show createPrivateKeysResultV2 details
A list of Private Key IDs and addresses.
Show privateKeys details
Show privateKeys details
addresses field
Show addresses details
Show addresses details
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_XRP
createSubOrganizationResultV3 field
Show createSubOrganizationResultV3 details
Show createSubOrganizationResultV3 details
subOrganizationId field
A list of Private Key IDs and addresses.
Show privateKeys details
Show privateKeys details
addresses field
Show addresses details
Show addresses details
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_XRP
createWalletResult field
setOrganizationFeatureResult field
Show setOrganizationFeatureResult details
Show setOrganizationFeatureResult details
Resulting list of organization features.
Show features details
Show features details
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
removeOrganizationFeatureResult field
Show removeOrganizationFeatureResult details
Show removeOrganizationFeatureResult details
Resulting list of organization features.
Show features details
Show features details
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
exportPrivateKeyResult field
exportWalletResult field
Show exportWalletResult details
Show exportWalletResult details
createSubOrganizationResultV4 field
Show createSubOrganizationResultV4 details
Show createSubOrganizationResultV4 details
subOrganizationId field
wallet field
Show wallet details
Show wallet details
exportWalletAccountResult field
importWalletResult field
importPrivateKeyResult field
Show importPrivateKeyResult details
Show importPrivateKeyResult details
Unique identifier for a Private Key.
A list of addresses.
Show addresses details
Show addresses details
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_XRP
signRawPayloadsResult field
Show signRawPayloadsResult details
Show signRawPayloadsResult details
signatures field
Show signatures details
Show signatures details
createReadOnlySessionResult field
Show createReadOnlySessionResult details
Show createReadOnlySessionResult details
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.
String representing a read only session
createSubOrganizationResultV5 field
Show createSubOrganizationResultV5 details
Show createSubOrganizationResultV5 details
subOrganizationId field
wallet field
Show wallet details
Show wallet details
oauthResult field
Show oauthResult details
Show oauthResult details
createReadWriteSessionResult field
Show createReadWriteSessionResult details
Show createReadWriteSessionResult details
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.
Unique identifier for the created API key.
createSubOrganizationResultV6 field
Show createSubOrganizationResultV6 details
Show createSubOrganizationResultV6 details
subOrganizationId field
wallet field
Show wallet details
Show wallet details
createReadWriteSessionResultV2 field
Show createReadWriteSessionResultV2 details
Show createReadWriteSessionResultV2 details
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.
otpAuthResult field
createSubOrganizationResultV7 field
Show createSubOrganizationResultV7 details
Show createSubOrganizationResultV7 details
subOrganizationId field
wallet field
Show wallet details
Show wallet details
A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.
Show votes details
Show votes details
user field
Show user details
Show user details
A list of Authenticator parameters.
Show authenticators details
Show authenticators details
Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).
Identifier indicating the type of the Security Key.
Unique identifier for a WebAuthn credential.
credential field
Show credential details
Show credential details
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
Unique identifier for a given Authenticator.
Human-readable name for an Authenticator.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
Show apiKeys details
credential field
Show credential details
Show credential details
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
A list of Oauth Providers.
Show oauthProviders details
Show oauthProviders details
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
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
selection field
Enum options: VOTE_SELECTION_APPROVED, VOTE_SELECTION_REJECTED
The public component of a cryptographic key pair used to sign messages and transactions.
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"activityId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<ACTIVITY_STATUS_CREATED>",
"type": "<ACTIVITY_TYPE_CREATE_API_KEYS>",
"intent": {
"createOrganizationIntent": {
"organizationName": "<string>",
"rootEmail": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
},
"rootUserId": "<string>"
},
"createAuthenticatorsIntent": {
"authenticators": [
{
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
],
"userId": "<string>"
},
"createUsersIntent": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"accessType": "<ACCESS_TYPE_WEB>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
],
"userTags": [
"<string_element>"
]
}
]
},
"createPrivateKeysIntent": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"signRawPayloadIntent": {
"privateKeyId": "<string>",
"payload": "<string>",
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"createInvitationsIntent": {
"invitations": [
{
"receiverUserName": "<string>",
"receiverUserEmail": "<string>",
"receiverUserTags": [
"<string_element>"
],
"accessType": "<ACCESS_TYPE_WEB>",
"senderUserId": "<string>"
}
]
},
"acceptInvitationIntent": {
"invitationId": "<string>",
"userId": "<string>",
"authenticator": {
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
},
"createPolicyIntent": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "<OPERATOR_EQUAL>",
"target": "<string>"
}
],
"effect": "<EFFECT_ALLOW>",
"notes": "<string>"
},
"disablePrivateKeyIntent": {
"privateKeyId": "<string>"
},
"deleteUsersIntent": {
"userIds": [
"<string_element>"
]
},
"deleteAuthenticatorsIntent": {
"userId": "<string>",
"authenticatorIds": [
"<string_element>"
]
},
"deleteInvitationIntent": {
"invitationId": "<string>"
},
"deleteOrganizationIntent": {
"organizationId": "<string>"
},
"deletePolicyIntent": {
"policyId": "<string>"
},
"createUserTagIntent": {
"userTagName": "<string>",
"userIds": [
"<string_element>"
]
},
"deleteUserTagsIntent": {
"userTagIds": [
"<string_element>"
]
},
"signTransactionIntent": {
"privateKeyId": "<string>",
"unsignedTransaction": "<string>",
"type": "<TRANSACTION_TYPE_ETHEREUM>"
},
"createApiKeysIntent": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"deleteApiKeysIntent": {
"userId": "<string>",
"apiKeyIds": [
"<string_element>"
]
},
"approveActivityIntent": {
"fingerprint": "<string>"
},
"rejectActivityIntent": {
"fingerprint": "<string>"
},
"createPrivateKeyTagIntent": {
"privateKeyTagName": "<string>",
"privateKeyIds": [
"<string_element>"
]
},
"deletePrivateKeyTagsIntent": {
"privateKeyTagIds": [
"<string_element>"
]
},
"createPolicyIntentV2": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "<OPERATOR_EQUAL>",
"targets": [
"<string_element>"
]
}
],
"effect": "<EFFECT_ALLOW>",
"notes": "<string>"
},
"setPaymentMethodIntent": {
"number": "<string>",
"cvv": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>",
"cardHolderEmail": "<string>",
"cardHolderName": "<string>"
},
"activateBillingTierIntent": {
"productId": "<string>"
},
"deletePaymentMethodIntent": {
"paymentMethodId": "<string>"
},
"createPolicyIntentV3": {
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
},
"createApiOnlyUsersIntent": {
"apiOnlyUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"userTags": [
"<string_element>"
],
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
]
}
]
},
"updateRootQuorumIntent": {
"threshold": 123,
"userIds": [
"<string_element>"
]
},
"updateUserTagIntent": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string_element>"
],
"removeUserIds": [
"<string_element>"
]
},
"updatePrivateKeyTagIntent": {
"privateKeyTagId": "<string>",
"newPrivateKeyTagName": "<string>",
"addPrivateKeyIds": [
"<string_element>"
],
"removePrivateKeyIds": [
"<string_element>"
]
},
"createAuthenticatorsIntentV2": {
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"userId": "<string>"
},
"acceptInvitationIntentV2": {
"invitationId": "<string>",
"userId": "<string>",
"authenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
},
"createOrganizationIntentV2": {
"organizationName": "<string>",
"rootEmail": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
},
"rootUserId": "<string>"
},
"createUsersIntentV2": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"userTags": [
"<string_element>"
]
}
]
},
"createSubOrganizationIntent": {
"name": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
},
"createSubOrganizationIntentV2": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123
},
"updateAllowedOriginsIntent": {
"allowedOrigins": [
"<string_element>"
]
},
"createPrivateKeysIntentV2": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"updateUserIntent": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string_element>"
],
"userPhoneNumber": "<string>"
},
"updatePolicyIntent": {
"policyId": "<string>",
"policyName": "<string>",
"policyEffect": "<EFFECT_ALLOW>",
"policyCondition": "<string>",
"policyConsensus": "<string>",
"policyNotes": "<string>"
},
"setPaymentMethodIntentV2": {
"paymentMethodId": "<string>",
"cardHolderEmail": "<string>",
"cardHolderName": "<string>"
},
"createSubOrganizationIntentV3": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123,
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"createWalletIntent": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"createWalletAccountsIntent": {
"walletId": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
]
},
"initUserEmailRecoveryIntent": {
"email": "<string>",
"targetPublicKey": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
}
},
"recoverUserIntent": {
"authenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
},
"userId": "<string>"
},
"setOrganizationFeatureIntent": {
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
},
"removeOrganizationFeatureIntent": {
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>"
},
"signRawPayloadIntentV2": {
"signWith": "<string>",
"payload": "<string>",
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"signTransactionIntentV2": {
"signWith": "<string>",
"unsignedTransaction": "<string>",
"type": "<TRANSACTION_TYPE_ETHEREUM>"
},
"exportPrivateKeyIntent": {
"privateKeyId": "<string>",
"targetPublicKey": "<string>"
},
"exportWalletIntent": {
"walletId": "<string>",
"targetPublicKey": "<string>",
"language": "<MNEMONIC_LANGUAGE_ENGLISH>"
},
"createSubOrganizationIntentV4": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"emailAuthIntent": {
"email": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"invalidateExisting": true,
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"exportWalletAccountIntent": {
"address": "<string>",
"targetPublicKey": "<string>"
},
"initImportWalletIntent": {
"userId": "<string>"
},
"importWalletIntent": {
"userId": "<string>",
"walletName": "<string>",
"encryptedBundle": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
]
},
"initImportPrivateKeyIntent": {
"userId": "<string>"
},
"importPrivateKeyIntent": {
"userId": "<string>",
"privateKeyName": "<string>",
"encryptedBundle": "<string>",
"curve": "<CURVE_SECP256K1>",
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
},
"createPoliciesIntent": {
"policies": [
{
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
}
]
},
"signRawPayloadsIntent": {
"signWith": "<string>",
"payloads": [
"<string_element>"
],
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"createReadOnlySessionIntent": "<object>",
"createOauthProvidersIntent": {
"userId": "<string>",
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
},
"deleteOauthProvidersIntent": {
"userId": "<string>",
"providerIds": [
"<string_element>"
]
},
"createSubOrganizationIntentV5": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"oauthIntent": {
"oidcToken": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"createApiKeysIntentV2": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"createReadWriteSessionIntent": {
"targetPublicKey": "<string>",
"email": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
},
"emailAuthIntentV2": {
"email": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"invalidateExisting": true,
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"createSubOrganizationIntentV6": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"deletePrivateKeysIntent": {
"privateKeyIds": [
"<string_element>"
],
"deleteWithoutExport": true
},
"deleteWalletsIntent": {
"walletIds": [
"<string_element>"
],
"deleteWithoutExport": true
},
"createReadWriteSessionIntentV2": {
"targetPublicKey": "<string>",
"userId": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"deleteSubOrganizationIntent": {
"deleteWithoutExport": true
},
"initOtpAuthIntent": {
"otpType": "<string>",
"contact": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"smsCustomization": {
"template": "<string>"
},
"userIdentifier": "<string>",
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"otpAuthIntent": {
"otpId": "<string>",
"otpCode": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"createSubOrganizationIntentV7": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true,
"disableSmsAuth": true,
"disableOtpEmailAuth": true
},
"updateWalletIntent": {
"walletId": "<string>",
"walletName": "<string>"
},
"updatePolicyIntentV2": {
"policyId": "<string>",
"policyName": "<string>",
"policyEffect": "<EFFECT_ALLOW>",
"policyCondition": "<string>",
"policyConsensus": "<string>",
"policyNotes": "<string>"
},
"createUsersIntentV3": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
],
"userTags": [
"<string_element>"
]
}
]
},
"initOtpAuthIntentV2": {
"otpType": "<string>",
"contact": "<string>",
"otpLength": 123,
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"smsCustomization": {
"template": "<string>"
},
"userIdentifier": "<string>",
"sendFromEmailAddress": "<string>",
"alphanumeric": true,
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
}
},
"result": {
"createOrganizationResult": {
"organizationId": "<string>"
},
"createAuthenticatorsResult": {
"authenticatorIds": [
"<string_element>"
]
},
"createUsersResult": {
"userIds": [
"<string_element>"
]
},
"createPrivateKeysResult": {
"privateKeyIds": [
"<string_element>"
]
},
"createInvitationsResult": {
"invitationIds": [
"<string_element>"
]
},
"acceptInvitationResult": {
"invitationId": "<string>",
"userId": "<string>"
},
"signRawPayloadResult": {
"r": "<string>",
"s": "<string>",
"v": "<string>"
},
"createPolicyResult": {
"policyId": "<string>"
},
"disablePrivateKeyResult": {
"privateKeyId": "<string>"
},
"deleteUsersResult": {
"userIds": [
"<string_element>"
]
},
"deleteAuthenticatorsResult": {
"authenticatorIds": [
"<string_element>"
]
},
"deleteInvitationResult": {
"invitationId": "<string>"
},
"deleteOrganizationResult": {
"organizationId": "<string>"
},
"deletePolicyResult": {
"policyId": "<string>"
},
"createUserTagResult": {
"userTagId": "<string>",
"userIds": [
"<string_element>"
]
},
"deleteUserTagsResult": {
"userTagIds": [
"<string_element>"
],
"userIds": [
"<string_element>"
]
},
"signTransactionResult": {
"signedTransaction": "<string>"
},
"deleteApiKeysResult": {
"apiKeyIds": [
"<string_element>"
]
},
"createApiKeysResult": {
"apiKeyIds": [
"<string_element>"
]
},
"createPrivateKeyTagResult": {
"privateKeyTagId": "<string>",
"privateKeyIds": [
"<string_element>"
]
},
"deletePrivateKeyTagsResult": {
"privateKeyTagIds": [
"<string_element>"
],
"privateKeyIds": [
"<string_element>"
]
},
"setPaymentMethodResult": {
"lastFour": "<string>",
"cardHolderName": "<string>",
"cardHolderEmail": "<string>"
},
"activateBillingTierResult": {
"productId": "<string>"
},
"deletePaymentMethodResult": {
"paymentMethodId": "<string>"
},
"createApiOnlyUsersResult": {
"userIds": [
"<string_element>"
]
},
"updateRootQuorumResult": "<object>",
"updateUserTagResult": {
"userTagId": "<string>"
},
"updatePrivateKeyTagResult": {
"privateKeyTagId": "<string>"
},
"createSubOrganizationResult": {
"subOrganizationId": "<string>",
"rootUserIds": [
"<string_element>"
]
},
"updateAllowedOriginsResult": "<object>",
"createPrivateKeysResultV2": {
"privateKeys": [
{
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
}
]
},
"updateUserResult": {
"userId": "<string>"
},
"updatePolicyResult": {
"policyId": "<string>"
},
"createSubOrganizationResultV3": {
"subOrganizationId": "<string>",
"privateKeys": [
{
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
}
],
"rootUserIds": [
"<string_element>"
]
},
"createWalletResult": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"createWalletAccountsResult": {
"addresses": [
"<string_element>"
]
},
"initUserEmailRecoveryResult": {
"userId": "<string>"
},
"recoverUserResult": {
"authenticatorId": [
"<string_element>"
]
},
"setOrganizationFeatureResult": {
"features": [
{
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
}
]
},
"removeOrganizationFeatureResult": {
"features": [
{
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
}
]
},
"exportPrivateKeyResult": {
"privateKeyId": "<string>",
"exportBundle": "<string>"
},
"exportWalletResult": {
"walletId": "<string>",
"exportBundle": "<string>"
},
"createSubOrganizationResultV4": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"emailAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>"
},
"exportWalletAccountResult": {
"address": "<string>",
"exportBundle": "<string>"
},
"initImportWalletResult": {
"importBundle": "<string>"
},
"importWalletResult": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"initImportPrivateKeyResult": {
"importBundle": "<string>"
},
"importPrivateKeyResult": {
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
},
"createPoliciesResult": {
"policyIds": [
"<string_element>"
]
},
"signRawPayloadsResult": {
"signatures": [
{
"r": "<string>",
"s": "<string>",
"v": "<string>"
}
]
},
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
},
"createOauthProvidersResult": {
"providerIds": [
"<string_element>"
]
},
"deleteOauthProvidersResult": {
"providerIds": [
"<string_element>"
]
},
"createSubOrganizationResultV5": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"oauthResult": {
"userId": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createReadWriteSessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createSubOrganizationResultV6": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"deletePrivateKeysResult": {
"privateKeyIds": [
"<string_element>"
]
},
"deleteWalletsResult": {
"walletIds": [
"<string_element>"
]
},
"createReadWriteSessionResultV2": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"deleteSubOrganizationResult": {
"subOrganizationUuid": "<string>"
},
"initOtpAuthResult": {
"otpId": "<string>"
},
"otpAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createSubOrganizationResultV7": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"updateWalletResult": {
"walletId": "<string>"
},
"updatePolicyResultV2": {
"policyId": "<string>"
},
"initOtpAuthResultV2": {
"otpId": "<string>"
}
},
"votes": [
{
"id": "<string>",
"userId": "<string>",
"user": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"authenticators": [
{
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"attestationType": "<string>",
"aaguid": "<string>",
"credentialId": "<string>",
"model": "<string>",
"credential": {
"publicKey": "<string>",
"type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
},
"authenticatorId": "<string>",
"authenticatorName": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"apiKeys": [
{
"credential": {
"publicKey": "<string>",
"type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
},
"apiKeyId": "<string>",
"apiKeyName": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"expirationSeconds": "<string>"
}
],
"userTags": [
"<string_element>"
],
"oauthProviders": [
{
"providerId": "<string>",
"providerName": "<string>",
"issuer": "<string>",
"audience": "<string>",
"subject": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
},
"activityId": "<string>",
"selection": "<VOTE_SELECTION_APPROVED>",
"message": "<string>",
"publicKey": "<string>",
"signature": "<string>",
"scheme": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"fingerprint": "<string>",
"canApprove": true,
"canReject": true,
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"failure": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}
}
}
}
Was this page helpful?
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"activityId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<ACTIVITY_STATUS_CREATED>",
"type": "<ACTIVITY_TYPE_CREATE_API_KEYS>",
"intent": {
"createOrganizationIntent": {
"organizationName": "<string>",
"rootEmail": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
},
"rootUserId": "<string>"
},
"createAuthenticatorsIntent": {
"authenticators": [
{
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
],
"userId": "<string>"
},
"createUsersIntent": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"accessType": "<ACCESS_TYPE_WEB>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
],
"userTags": [
"<string_element>"
]
}
]
},
"createPrivateKeysIntent": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"signRawPayloadIntent": {
"privateKeyId": "<string>",
"payload": "<string>",
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"createInvitationsIntent": {
"invitations": [
{
"receiverUserName": "<string>",
"receiverUserEmail": "<string>",
"receiverUserTags": [
"<string_element>"
],
"accessType": "<ACCESS_TYPE_WEB>",
"senderUserId": "<string>"
}
]
},
"acceptInvitationIntent": {
"invitationId": "<string>",
"userId": "<string>",
"authenticator": {
"authenticatorName": "<string>",
"userId": "<string>",
"attestation": {
"id": "<string>",
"type": "<public-key>",
"rawId": "<string>",
"authenticatorAttachment": "<cross-platform>",
"response": {
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"authenticatorAttachment": "<cross-platform>"
},
"clientExtensionResults": {
"appid": true,
"appidExclude": true,
"credProps": {
"rk": true
}
}
},
"challenge": "<string>"
}
},
"createPolicyIntent": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "<OPERATOR_EQUAL>",
"target": "<string>"
}
],
"effect": "<EFFECT_ALLOW>",
"notes": "<string>"
},
"disablePrivateKeyIntent": {
"privateKeyId": "<string>"
},
"deleteUsersIntent": {
"userIds": [
"<string_element>"
]
},
"deleteAuthenticatorsIntent": {
"userId": "<string>",
"authenticatorIds": [
"<string_element>"
]
},
"deleteInvitationIntent": {
"invitationId": "<string>"
},
"deleteOrganizationIntent": {
"organizationId": "<string>"
},
"deletePolicyIntent": {
"policyId": "<string>"
},
"createUserTagIntent": {
"userTagName": "<string>",
"userIds": [
"<string_element>"
]
},
"deleteUserTagsIntent": {
"userTagIds": [
"<string_element>"
]
},
"signTransactionIntent": {
"privateKeyId": "<string>",
"unsignedTransaction": "<string>",
"type": "<TRANSACTION_TYPE_ETHEREUM>"
},
"createApiKeysIntent": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"deleteApiKeysIntent": {
"userId": "<string>",
"apiKeyIds": [
"<string_element>"
]
},
"approveActivityIntent": {
"fingerprint": "<string>"
},
"rejectActivityIntent": {
"fingerprint": "<string>"
},
"createPrivateKeyTagIntent": {
"privateKeyTagName": "<string>",
"privateKeyIds": [
"<string_element>"
]
},
"deletePrivateKeyTagsIntent": {
"privateKeyTagIds": [
"<string_element>"
]
},
"createPolicyIntentV2": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "<OPERATOR_EQUAL>",
"targets": [
"<string_element>"
]
}
],
"effect": "<EFFECT_ALLOW>",
"notes": "<string>"
},
"setPaymentMethodIntent": {
"number": "<string>",
"cvv": "<string>",
"expiryMonth": "<string>",
"expiryYear": "<string>",
"cardHolderEmail": "<string>",
"cardHolderName": "<string>"
},
"activateBillingTierIntent": {
"productId": "<string>"
},
"deletePaymentMethodIntent": {
"paymentMethodId": "<string>"
},
"createPolicyIntentV3": {
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
},
"createApiOnlyUsersIntent": {
"apiOnlyUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"userTags": [
"<string_element>"
],
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
]
}
]
},
"updateRootQuorumIntent": {
"threshold": 123,
"userIds": [
"<string_element>"
]
},
"updateUserTagIntent": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string_element>"
],
"removeUserIds": [
"<string_element>"
]
},
"updatePrivateKeyTagIntent": {
"privateKeyTagId": "<string>",
"newPrivateKeyTagName": "<string>",
"addPrivateKeyIds": [
"<string_element>"
],
"removePrivateKeyIds": [
"<string_element>"
]
},
"createAuthenticatorsIntentV2": {
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"userId": "<string>"
},
"acceptInvitationIntentV2": {
"invitationId": "<string>",
"userId": "<string>",
"authenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
},
"createOrganizationIntentV2": {
"organizationName": "<string>",
"rootEmail": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
},
"rootUserId": "<string>"
},
"createUsersIntentV2": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"userTags": [
"<string_element>"
]
}
]
},
"createSubOrganizationIntent": {
"name": "<string>",
"rootAuthenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
},
"createSubOrganizationIntentV2": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123
},
"updateAllowedOriginsIntent": {
"allowedOrigins": [
"<string_element>"
]
},
"createPrivateKeysIntentV2": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"updateUserIntent": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string_element>"
],
"userPhoneNumber": "<string>"
},
"updatePolicyIntent": {
"policyId": "<string>",
"policyName": "<string>",
"policyEffect": "<EFFECT_ALLOW>",
"policyCondition": "<string>",
"policyConsensus": "<string>",
"policyNotes": "<string>"
},
"setPaymentMethodIntentV2": {
"paymentMethodId": "<string>",
"cardHolderEmail": "<string>",
"cardHolderName": "<string>"
},
"createSubOrganizationIntentV3": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123,
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "<CURVE_SECP256K1>",
"privateKeyTags": [
"<string_element>"
],
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
}
]
},
"createWalletIntent": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"createWalletAccountsIntent": {
"walletId": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
]
},
"initUserEmailRecoveryIntent": {
"email": "<string>",
"targetPublicKey": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
}
},
"recoverUserIntent": {
"authenticator": {
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
},
"userId": "<string>"
},
"setOrganizationFeatureIntent": {
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
},
"removeOrganizationFeatureIntent": {
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>"
},
"signRawPayloadIntentV2": {
"signWith": "<string>",
"payload": "<string>",
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"signTransactionIntentV2": {
"signWith": "<string>",
"unsignedTransaction": "<string>",
"type": "<TRANSACTION_TYPE_ETHEREUM>"
},
"exportPrivateKeyIntent": {
"privateKeyId": "<string>",
"targetPublicKey": "<string>"
},
"exportWalletIntent": {
"walletId": "<string>",
"targetPublicKey": "<string>",
"language": "<MNEMONIC_LANGUAGE_ENGLISH>"
},
"createSubOrganizationIntentV4": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"emailAuthIntent": {
"email": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"invalidateExisting": true,
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"exportWalletAccountIntent": {
"address": "<string>",
"targetPublicKey": "<string>"
},
"initImportWalletIntent": {
"userId": "<string>"
},
"importWalletIntent": {
"userId": "<string>",
"walletName": "<string>",
"encryptedBundle": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
]
},
"initImportPrivateKeyIntent": {
"userId": "<string>"
},
"importPrivateKeyIntent": {
"userId": "<string>",
"privateKeyName": "<string>",
"encryptedBundle": "<string>",
"curve": "<CURVE_SECP256K1>",
"addressFormats": [
"<ADDRESS_FORMAT_UNCOMPRESSED>"
]
},
"createPoliciesIntent": {
"policies": [
{
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
}
]
},
"signRawPayloadsIntent": {
"signWith": "<string>",
"payloads": [
"<string_element>"
],
"encoding": "<PAYLOAD_ENCODING_HEXADECIMAL>",
"hashFunction": "<HASH_FUNCTION_NO_OP>"
},
"createReadOnlySessionIntent": "<object>",
"createOauthProvidersIntent": {
"userId": "<string>",
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
},
"deleteOauthProvidersIntent": {
"userId": "<string>",
"providerIds": [
"<string_element>"
]
},
"createSubOrganizationIntentV5": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"oauthIntent": {
"oidcToken": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"createApiKeysIntentV2": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"createReadWriteSessionIntent": {
"targetPublicKey": "<string>",
"email": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
},
"emailAuthIntentV2": {
"email": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"invalidateExisting": true,
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"createSubOrganizationIntentV6": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true
},
"deletePrivateKeysIntent": {
"privateKeyIds": [
"<string_element>"
],
"deleteWithoutExport": true
},
"deleteWalletsIntent": {
"walletIds": [
"<string_element>"
],
"deleteWithoutExport": true
},
"createReadWriteSessionIntentV2": {
"targetPublicKey": "<string>",
"userId": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"deleteSubOrganizationIntent": {
"deleteWithoutExport": true
},
"initOtpAuthIntent": {
"otpType": "<string>",
"contact": "<string>",
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"smsCustomization": {
"template": "<string>"
},
"userIdentifier": "<string>",
"sendFromEmailAddress": "<string>",
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
},
"otpAuthIntent": {
"otpId": "<string>",
"otpCode": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>",
"invalidateExisting": true
},
"createSubOrganizationIntentV7": {
"subOrganizationName": "<string>",
"rootUsers": [
{
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
}
],
"rootQuorumThreshold": 123,
"wallet": {
"walletName": "<string>",
"accounts": [
{
"curve": "<CURVE_SECP256K1>",
"pathFormat": "<PATH_FORMAT_BIP32>",
"path": "<string>",
"addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
}
],
"mnemonicLength": 123
},
"disableEmailRecovery": true,
"disableEmailAuth": true,
"disableSmsAuth": true,
"disableOtpEmailAuth": true
},
"updateWalletIntent": {
"walletId": "<string>",
"walletName": "<string>"
},
"updatePolicyIntentV2": {
"policyId": "<string>",
"policyName": "<string>",
"policyEffect": "<EFFECT_ALLOW>",
"policyCondition": "<string>",
"policyConsensus": "<string>",
"policyNotes": "<string>"
},
"createUsersIntentV3": {
"users": [
{
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"curveType": "<API_KEY_CURVE_P256>",
"expirationSeconds": "<string>"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
]
}
}
],
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
],
"userTags": [
"<string_element>"
]
}
]
},
"initOtpAuthIntentV2": {
"otpType": "<string>",
"contact": "<string>",
"otpLength": 123,
"emailCustomization": {
"appName": "<string>",
"logoUrl": "<string>",
"magicLinkTemplate": "<string>",
"templateVariables": "<string>",
"templateId": "<string>"
},
"smsCustomization": {
"template": "<string>"
},
"userIdentifier": "<string>",
"sendFromEmailAddress": "<string>",
"alphanumeric": true,
"sendFromEmailSenderName": "<string>",
"replyToEmailAddress": "<string>"
}
},
"result": {
"createOrganizationResult": {
"organizationId": "<string>"
},
"createAuthenticatorsResult": {
"authenticatorIds": [
"<string_element>"
]
},
"createUsersResult": {
"userIds": [
"<string_element>"
]
},
"createPrivateKeysResult": {
"privateKeyIds": [
"<string_element>"
]
},
"createInvitationsResult": {
"invitationIds": [
"<string_element>"
]
},
"acceptInvitationResult": {
"invitationId": "<string>",
"userId": "<string>"
},
"signRawPayloadResult": {
"r": "<string>",
"s": "<string>",
"v": "<string>"
},
"createPolicyResult": {
"policyId": "<string>"
},
"disablePrivateKeyResult": {
"privateKeyId": "<string>"
},
"deleteUsersResult": {
"userIds": [
"<string_element>"
]
},
"deleteAuthenticatorsResult": {
"authenticatorIds": [
"<string_element>"
]
},
"deleteInvitationResult": {
"invitationId": "<string>"
},
"deleteOrganizationResult": {
"organizationId": "<string>"
},
"deletePolicyResult": {
"policyId": "<string>"
},
"createUserTagResult": {
"userTagId": "<string>",
"userIds": [
"<string_element>"
]
},
"deleteUserTagsResult": {
"userTagIds": [
"<string_element>"
],
"userIds": [
"<string_element>"
]
},
"signTransactionResult": {
"signedTransaction": "<string>"
},
"deleteApiKeysResult": {
"apiKeyIds": [
"<string_element>"
]
},
"createApiKeysResult": {
"apiKeyIds": [
"<string_element>"
]
},
"createPrivateKeyTagResult": {
"privateKeyTagId": "<string>",
"privateKeyIds": [
"<string_element>"
]
},
"deletePrivateKeyTagsResult": {
"privateKeyTagIds": [
"<string_element>"
],
"privateKeyIds": [
"<string_element>"
]
},
"setPaymentMethodResult": {
"lastFour": "<string>",
"cardHolderName": "<string>",
"cardHolderEmail": "<string>"
},
"activateBillingTierResult": {
"productId": "<string>"
},
"deletePaymentMethodResult": {
"paymentMethodId": "<string>"
},
"createApiOnlyUsersResult": {
"userIds": [
"<string_element>"
]
},
"updateRootQuorumResult": "<object>",
"updateUserTagResult": {
"userTagId": "<string>"
},
"updatePrivateKeyTagResult": {
"privateKeyTagId": "<string>"
},
"createSubOrganizationResult": {
"subOrganizationId": "<string>",
"rootUserIds": [
"<string_element>"
]
},
"updateAllowedOriginsResult": "<object>",
"createPrivateKeysResultV2": {
"privateKeys": [
{
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
}
]
},
"updateUserResult": {
"userId": "<string>"
},
"updatePolicyResult": {
"policyId": "<string>"
},
"createSubOrganizationResultV3": {
"subOrganizationId": "<string>",
"privateKeys": [
{
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
}
],
"rootUserIds": [
"<string_element>"
]
},
"createWalletResult": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"createWalletAccountsResult": {
"addresses": [
"<string_element>"
]
},
"initUserEmailRecoveryResult": {
"userId": "<string>"
},
"recoverUserResult": {
"authenticatorId": [
"<string_element>"
]
},
"setOrganizationFeatureResult": {
"features": [
{
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
}
]
},
"removeOrganizationFeatureResult": {
"features": [
{
"name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
"value": "<string>"
}
]
},
"exportPrivateKeyResult": {
"privateKeyId": "<string>",
"exportBundle": "<string>"
},
"exportWalletResult": {
"walletId": "<string>",
"exportBundle": "<string>"
},
"createSubOrganizationResultV4": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"emailAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>"
},
"exportWalletAccountResult": {
"address": "<string>",
"exportBundle": "<string>"
},
"initImportWalletResult": {
"importBundle": "<string>"
},
"importWalletResult": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"initImportPrivateKeyResult": {
"importBundle": "<string>"
},
"importPrivateKeyResult": {
"privateKeyId": "<string>",
"addresses": [
{
"format": "<ADDRESS_FORMAT_UNCOMPRESSED>",
"address": "<string>"
}
]
},
"createPoliciesResult": {
"policyIds": [
"<string_element>"
]
},
"signRawPayloadsResult": {
"signatures": [
{
"r": "<string>",
"s": "<string>",
"v": "<string>"
}
]
},
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
},
"createOauthProvidersResult": {
"providerIds": [
"<string_element>"
]
},
"deleteOauthProvidersResult": {
"providerIds": [
"<string_element>"
]
},
"createSubOrganizationResultV5": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"oauthResult": {
"userId": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createReadWriteSessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createSubOrganizationResultV6": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"deletePrivateKeysResult": {
"privateKeyIds": [
"<string_element>"
]
},
"deleteWalletsResult": {
"walletIds": [
"<string_element>"
]
},
"createReadWriteSessionResultV2": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"deleteSubOrganizationResult": {
"subOrganizationUuid": "<string>"
},
"initOtpAuthResult": {
"otpId": "<string>"
},
"otpAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>",
"credentialBundle": "<string>"
},
"createSubOrganizationResultV7": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string_element>"
]
},
"rootUserIds": [
"<string_element>"
]
},
"updateWalletResult": {
"walletId": "<string>"
},
"updatePolicyResultV2": {
"policyId": "<string>"
},
"initOtpAuthResultV2": {
"otpId": "<string>"
}
},
"votes": [
{
"id": "<string>",
"userId": "<string>",
"user": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userPhoneNumber": "<string>",
"authenticators": [
{
"transports": [
"<AUTHENTICATOR_TRANSPORT_BLE>"
],
"attestationType": "<string>",
"aaguid": "<string>",
"credentialId": "<string>",
"model": "<string>",
"credential": {
"publicKey": "<string>",
"type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
},
"authenticatorId": "<string>",
"authenticatorName": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"apiKeys": [
{
"credential": {
"publicKey": "<string>",
"type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
},
"apiKeyId": "<string>",
"apiKeyName": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"expirationSeconds": "<string>"
}
],
"userTags": [
"<string_element>"
],
"oauthProviders": [
{
"providerId": "<string>",
"providerName": "<string>",
"issuer": "<string>",
"audience": "<string>",
"subject": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
},
"activityId": "<string>",
"selection": "<VOTE_SELECTION_APPROVED>",
"message": "<string>",
"publicKey": "<string>",
"signature": "<string>",
"scheme": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
],
"fingerprint": "<string>",
"canApprove": true,
"canReject": true,
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"failure": {
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}
}
}
}
}