API Reference
- Overview
- Organizations
- Invitations
- Policies
- Features
Wallets and Private Keys
- Wallets
- Signing
- Private Keys
- Private Key Tags
Users
- Users
- User Tags
- User Recovery
- User Auth
Credentials
- Authenticators
- API keys
- Sessions
Activities
- Activities
- Consensus
Oauth
Authenticate a user with an Oidc token (Oauth) - BETA
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/oauth \
--header 'Content-Type: application/json' \
--header 'X-Stamp: <api-key>' \
--data '{
"type": "ACTIVITY_TYPE_OAUTH",
"timestampMs": "<string>",
"organizationId": "<string>",
"parameters": {
"oidcToken": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
}
}'{
"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>"
]
}
]
},
"createPrivateKeysIntent": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "CURVE_SECP256K1",
"privateKeyTags": [
"<string>"
],
"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>"
],
"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>"
]
},
"deleteAuthenticatorsIntent": {
"userId": "<string>",
"authenticatorIds": [
"<string>"
]
},
"deleteInvitationIntent": {
"invitationId": "<string>"
},
"deleteOrganizationIntent": {
"organizationId": "<string>"
},
"deletePolicyIntent": {
"policyId": "<string>"
},
"createUserTagIntent": {
"userTagName": "<string>",
"userIds": [
"<string>"
]
},
"deleteUserTagsIntent": {
"userTagIds": [
"<string>"
]
},
"signTransactionIntent": {
"privateKeyId": "<string>",
"unsignedTransaction": "<string>",
"type": "TRANSACTION_TYPE_ETHEREUM"
},
"createApiKeysIntent": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"deleteApiKeysIntent": {
"userId": "<string>",
"apiKeyIds": [
"<string>"
]
},
"approveActivityIntent": {
"fingerprint": "<string>"
},
"rejectActivityIntent": {
"fingerprint": "<string>"
},
"createPrivateKeyTagIntent": {
"privateKeyTagName": "<string>",
"privateKeyIds": [
"<string>"
]
},
"deletePrivateKeyTagsIntent": {
"privateKeyTagIds": [
"<string>"
]
},
"createPolicyIntentV2": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "OPERATOR_EQUAL",
"targets": [
"<string>"
]
}
],
"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>"
],
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
]
}
]
},
"updateRootQuorumIntent": {
"threshold": 123,
"userIds": [
"<string>"
]
},
"updateUserTagIntent": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string>"
],
"removeUserIds": [
"<string>"
]
},
"updatePrivateKeyTagIntent": {
"privateKeyTagId": "<string>",
"newPrivateKeyTagName": "<string>",
"addPrivateKeyIds": [
"<string>"
],
"removePrivateKeyIds": [
"<string>"
]
},
"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>"
]
}
]
},
"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>"
]
},
"createPrivateKeysIntentV2": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "CURVE_SECP256K1",
"privateKeyTags": [
"<string>"
],
"addressFormats": [
"ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
},
"updateUserIntent": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string>"
],
"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>"
],
"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>"
},
"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>"
],
"encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
"hashFunction": "HASH_FUNCTION_NO_OP"
},
"createReadOnlySessionIntent": {},
"createOauthProvidersIntent": {
"userId": "<string>",
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
},
"deleteOauthProvidersIntent": {
"userId": "<string>",
"providerIds": [
"<string>"
]
},
"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>"
},
"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>"
},
"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>"
],
"deleteWithoutExport": true
},
"deleteWalletsIntent": {
"walletIds": [
"<string>"
],
"deleteWithoutExport": true
},
"createReadWriteSessionIntentV2": {
"targetPublicKey": "<string>",
"userId": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
},
"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>"
},
"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>"
}
},
"result": {
"createOrganizationResult": {
"organizationId": "<string>"
},
"createAuthenticatorsResult": {
"authenticatorIds": [
"<string>"
]
},
"createUsersResult": {
"userIds": [
"<string>"
]
},
"createPrivateKeysResult": {
"privateKeyIds": [
"<string>"
]
},
"createInvitationsResult": {
"invitationIds": [
"<string>"
]
},
"acceptInvitationResult": {
"invitationId": "<string>",
"userId": "<string>"
},
"signRawPayloadResult": {
"r": "<string>",
"s": "<string>",
"v": "<string>"
},
"createPolicyResult": {
"policyId": "<string>"
},
"disablePrivateKeyResult": {
"privateKeyId": "<string>"
},
"deleteUsersResult": {
"userIds": [
"<string>"
]
},
"deleteAuthenticatorsResult": {
"authenticatorIds": [
"<string>"
]
},
"deleteInvitationResult": {
"invitationId": "<string>"
},
"deleteOrganizationResult": {
"organizationId": "<string>"
},
"deletePolicyResult": {
"policyId": "<string>"
},
"createUserTagResult": {
"userTagId": "<string>",
"userIds": [
"<string>"
]
},
"deleteUserTagsResult": {
"userTagIds": [
"<string>"
],
"userIds": [
"<string>"
]
},
"signTransactionResult": {
"signedTransaction": "<string>"
},
"deleteApiKeysResult": {
"apiKeyIds": [
"<string>"
]
},
"createApiKeysResult": {
"apiKeyIds": [
"<string>"
]
},
"createPrivateKeyTagResult": {
"privateKeyTagId": "<string>",
"privateKeyIds": [
"<string>"
]
},
"deletePrivateKeyTagsResult": {
"privateKeyTagIds": [
"<string>"
],
"privateKeyIds": [
"<string>"
]
},
"setPaymentMethodResult": {
"lastFour": "<string>",
"cardHolderName": "<string>",
"cardHolderEmail": "<string>"
},
"activateBillingTierResult": {
"productId": "<string>"
},
"deletePaymentMethodResult": {
"paymentMethodId": "<string>"
},
"createApiOnlyUsersResult": {
"userIds": [
"<string>"
]
},
"updateRootQuorumResult": {},
"updateUserTagResult": {
"userTagId": "<string>"
},
"updatePrivateKeyTagResult": {
"privateKeyTagId": "<string>"
},
"createSubOrganizationResult": {
"subOrganizationId": "<string>",
"rootUserIds": [
"<string>"
]
},
"updateAllowedOriginsResult": {},
"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>"
]
},
"createWalletResult": {
"walletId": "<string>",
"addresses": [
"<string>"
]
},
"createWalletAccountsResult": {
"addresses": [
"<string>"
]
},
"initUserEmailRecoveryResult": {
"userId": "<string>"
},
"recoverUserResult": {
"authenticatorId": [
"<string>"
]
},
"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>"
]
},
"rootUserIds": [
"<string>"
]
},
"emailAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>"
},
"exportWalletAccountResult": {
"address": "<string>",
"exportBundle": "<string>"
},
"initImportWalletResult": {
"importBundle": "<string>"
},
"importWalletResult": {
"walletId": "<string>",
"addresses": [
"<string>"
]
},
"initImportPrivateKeyResult": {
"importBundle": "<string>"
},
"importPrivateKeyResult": {
"privateKeyId": "<string>",
"addresses": [
{
"format": "ADDRESS_FORMAT_UNCOMPRESSED",
"address": "<string>"
}
]
},
"createPoliciesResult": {
"policyIds": [
"<string>"
]
},
"signRawPayloadsResult": {
"signatures": [
{
"r": "<string>",
"s": "<string>",
"v": "<string>"
}
]
},
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
},
"createOauthProvidersResult": {
"providerIds": [
"<string>"
]
},
"deleteOauthProvidersResult": {
"providerIds": [
"<string>"
]
},
"createSubOrganizationResultV5": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string>"
]
},
"rootUserIds": [
"<string>"
]
},
"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>"
]
},
"rootUserIds": [
"<string>"
]
},
"deletePrivateKeysResult": {
"privateKeyIds": [
"<string>"
]
},
"deleteWalletsResult": {
"walletIds": [
"<string>"
]
},
"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>"
]
},
"rootUserIds": [
"<string>"
]
},
"updateWalletResult": {
"walletId": "<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>"
],
"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
ACTIVITY_TYPE_OAUTH Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
Base64 encoded OIDC token
Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Oauth - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
Response
Unique identifier for a given Activity object.
Unique identifier for a given Organization.
ACTIVITY_STATUS_CREATED, ACTIVITY_STATUS_PENDING, ACTIVITY_STATUS_COMPLETED, ACTIVITY_STATUS_FAILED, ACTIVITY_STATUS_CONSENSUS_NEEDED, ACTIVITY_STATUS_REJECTED 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 Human-readable name for an Organization.
The root user's email address.
Human-readable name for an Authenticator.
Unique identifier for a given User.
Challenge presented for authentication purposes.
Unique identifier for the root user object.
A list of Authenticators.
Human-readable name for an Authenticator.
Unique identifier for a given User.
Challenge presented for authentication purposes.
Unique identifier for a given User.
A list of Users.
Human-readable name for a User.
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.
The user's email address.
A list of Private Keys.
Human-readable name for a Private Key.
CURVE_SECP256K1, CURVE_ED25519 A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body.
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
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 Unique identifier for a given Private Key.
Raw unsigned payload to be signed.
PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8 HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE A list of Invitations.
The name of the intended Invitation recipient.
The email address of the intended Invitation recipient.
A list of tags assigned to the Invitation recipient. This field, if not needed, should be an empty array in your request body.
ACCESS_TYPE_WEB, ACCESS_TYPE_API, ACCESS_TYPE_ALL Unique identifier for the Sender of an Invitation.
Unique identifier for a given Invitation object.
Unique identifier for a given User.
Human-readable name for an Authenticator.
Unique identifier for a given User.
Challenge presented for authentication purposes.
Human-readable name for a Policy.
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
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_ALLOW, EFFECT_DENY Unique identifier for a given Private Key.
A list of User IDs.
Unique identifier for a given Invitation object.
Unique identifier for a given Organization.
Unique identifier for a given Policy.
A list of User Tag IDs.
Unique identifier for a given Private Key.
Raw unsigned transaction to be signed by a particular Private Key.
TRANSACTION_TYPE_ETHEREUM, TRANSACTION_TYPE_SOLANA A list of API Keys.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Optional window (in seconds) indicating how long the API Key should last.
Unique identifier for a given User.
An artifact verifying a User's action.
An artifact verifying a User's action.
A list of Private Key Tag IDs.
Human-readable name for a Policy.
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
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_ALLOW, EFFECT_DENY The account number of the customer's credit card.
The verification digits of the customer's credit card.
The month that the credit card expires.
The year that the credit card expires.
The email that will receive invoices for the credit card.
The name associated with the credit card.
The product that the customer wants to subscribe to.
The payment method that the customer wants to remove.
Human-readable name for a Policy.
EFFECT_ALLOW, EFFECT_DENY The condition expression that triggers the Effect
The consensus expression that triggers the Effect
A list of API-only Users to create.
The name of the new API-only User.
A list of tags assigned to the new API-only User. This field, if not needed, should be an empty array in your request body.
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
The email address for this API-only User (optional).
Unique identifier for a given User Tag.
A list of User IDs to add this tag to.
A list of User IDs to remove this tag from.
The new, human-readable name for the tag with the given ID.
Unique identifier for a given Private Key Tag.
A list of Private Keys IDs to add this tag to.
A list of Private Key IDs to remove this tag from.
The new, human-readable name for the tag with the given ID.
A list of Authenticators.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
Unique identifier for a given User.
Unique identifier for a given Invitation object.
Unique identifier for a given User.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
Human-readable name for an Organization.
The root user's email address.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
Unique identifier for the root user object.
A list of Users.
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.
The user's email address.
Name for this sub-organization
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
Name for this sub-organization
Root users to create within this sub-organization
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
The user's email address.
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
Additional origins requests are allowed from besides Turnkey origins
A list of Private Keys.
Human-readable name for a Private Key.
CURVE_SECP256K1, CURVE_ED25519 A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body.
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
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 Unique identifier for a given User.
Human-readable name for a User.
The user's email address.
An updated list of User Tags to apply to this User. This field, if not needed, should be an empty array in your request body.
The user's phone number in E.164 format e.g. +13214567890
Unique identifier for a given Policy.
Human-readable name for a Policy.
EFFECT_ALLOW, EFFECT_DENY The condition expression that triggers the Effect (optional).
The consensus expression that triggers the Effect (optional).
Accompanying notes for a Policy (optional).
The id of the payment method that was created clientside.
The email that will receive invoices for the credit card.
The name associated with the credit card.
Name for this sub-organization
Root users to create within this sub-organization
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
The user's email address.
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
A list of Private Keys.
Human-readable name for a Private Key.
CURVE_SECP256K1, CURVE_ED25519 A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body.
Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
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 Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
CURVE_SECP256K1, CURVE_ED25519 PATH_FORMAT_BIP32 Path used to generate a wallet Account.
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 Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Unique identifier for a given Wallet.
A list of wallet Accounts.
CURVE_SECP256K1, CURVE_ED25519 PATH_FORMAT_BIP32 Path used to generate a wallet Account.
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 Email of the user starting recovery
Client-side public key generated by the user, to which the recovery bundle will be encrypted.
Expiration window (in seconds) indicating how long the recovery credential is valid. If not provided, a default of 15 minutes will be used.
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. https://dapp.xyz/%s. The auth bundle will be interpolated into the %s.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
Unique identifier for the user performing recovery.
FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY, FEATURE_NAME_WEBAUTHN_ORIGINS, FEATURE_NAME_EMAIL_AUTH, FEATURE_NAME_EMAIL_RECOVERY, FEATURE_NAME_WEBHOOK, FEATURE_NAME_SMS_AUTH, FEATURE_NAME_OTP_EMAIL_AUTH Optional value for the feature. Will override existing values if feature is already set.
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 A Wallet account address, Private Key address, or Private Key identifier.
Raw unsigned payload to be signed.
PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8 HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE A Wallet account address, Private Key address, or Private Key identifier.
Raw unsigned transaction to be signed
TRANSACTION_TYPE_ETHEREUM, TRANSACTION_TYPE_SOLANA Unique identifier for a given Wallet.
Client-side public key generated by the user, to which the export bundle will be encrypted.
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 Name for this sub-organization
Root users to create within this sub-organization
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
The user's email address.
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
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.
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
Email of the authenticating user.
Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Email Auth - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. https://dapp.xyz/%s. The auth bundle will be interpolated into the %s.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
Invalidate all other previously generated Email Auth API keys
Optional custom email address from which to send the email
The ID of the User importing a Wallet.
The ID of the User importing a Wallet.
Human-readable name for a Wallet.
Bundle containing a wallet mnemonic encrypted to the enclave's target public key.
A list of wallet Accounts.
CURVE_SECP256K1, CURVE_ED25519 PATH_FORMAT_BIP32 Path used to generate a wallet Account.
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 The ID of the User importing a Private Key.
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_SECP256K1, CURVE_ED25519 Cryptocurrency-specific formats for a derived address (e.g., Ethereum).
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 An array of policy intents to be created.
Human-readable name for a Policy.
EFFECT_ALLOW, EFFECT_DENY The condition expression that triggers the Effect
The consensus expression that triggers the Effect
A Wallet account address, Private Key address, or Private Key identifier.
An array of raw unsigned payloads to be signed.
PAYLOAD_ENCODING_HEXADECIMAL, PAYLOAD_ENCODING_TEXT_UTF8 HASH_FUNCTION_NO_OP, HASH_FUNCTION_SHA256, HASH_FUNCTION_KECCAK256, HASH_FUNCTION_NOT_APPLICABLE The ID of the User to add an Oauth provider to
Name for this sub-organization
Root users to create within this sub-organization
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
The user's email address.
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
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.
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
Base64 encoded OIDC token
Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Oauth - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
A list of API Keys.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519 Optional window (in seconds) indicating how long the API Key should last.
Unique identifier for a given User.
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>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
Email of the authenticating user.
Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to Email Auth - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. https://dapp.xyz/%s. The auth bundle will be interpolated into the %s.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
Invalidate all other previously generated Email Auth API keys
Optional custom email address from which to send the email
Name for this sub-organization
Root users to create within this sub-organization
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
The user's email address.
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
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.
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
List of unique identifiers for private keys within an organization
Optional parameter for deleting the private keys, even if any have not been previously exported. If they have been exported, this field is ignored.
List of unique identifiers for wallets within an organization
Optional parameter for deleting the wallets, even if any have not been previously exported. If they have been exported, this field is ignored.
Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted.
Unique identifier for a given User.
Optional human-readable name for an API Key. If none provided, default to Read Write Session - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
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.
Enum to specifiy whether to send OTP via SMS or email
Email or phone number to send the OTP code to
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
A template for the URL to be used in a magic link button, e.g. https://dapp.xyz/%s. The auth bundle will be interpolated into the %s.
JSON object containing key/value pairs to be used with custom templates.
Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
Template containing references to .OtpCode i.e Your OTP is {{.OtpCode}}
Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address.
Optional custom email address from which to send the OTP email
ID representing the result of an init OTP activity.
6 digit OTP code sent out to a user's contact (email or SMS)
Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted.
Optional human-readable name for an API Key. If none provided, default to OTP Auth - <Timestamp>
Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
Invalidate all other previously generated OTP Auth API keys
Name for this sub-organization
Root users to create within this sub-organization
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.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
The user's email address.
The user's phone number in E.164 format e.g. +13214567890
The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users
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.
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
Disable email recovery for the sub-organization
Disable email auth for the sub-organization
Disable OTP SMS auth for the sub-organization
Disable OTP email auth for the sub-organization
Unique identifier for a given Organization.
A list of Authenticator IDs.
A list of User IDs.
A list of Private Key IDs.
A list of Invitation IDs
Unique identifier for a given Policy.
Unique identifier for a given Private Key.
A list of User IDs.
Unique identifier for a given Authenticator.
Unique identifier for a given Invitation.
Unique identifier for a given Organization.
Unique identifier for a given Policy.
A list of API Key IDs.
A list of API Key IDs.
The last four digits of the credit card added.
The name associated with the payment method.
The email address associated with the payment method.
The id of the product being subscribed to.
The payment method that was removed.
A list of API-only User IDs.
Unique identifier for a given User Tag.
Unique identifier for a given Private Key Tag.
A User ID.
Unique identifier for a given Policy.
A list of derived addresses.
Unique identifier for the user being recovered.
ID of the authenticator created.
Resulting list of organization features.
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 Resulting list of organization features.
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 Import bundle containing a public key and signature to use for importing client data.
Import bundle containing a public key and signature to use for importing client data.
Unique identifier for a Private Key.
A list of addresses.
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 A list of unique identifiers for the created policies.
Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.
Human-readable name for an Organization.
Unique identifier for a given User.
Human-readable name for a User.
String representing a read only session
UTC timestamp in seconds representing the expiry time for the read only session.
A list of unique identifiers for Oauth Providers
A list of unique identifiers for Oauth Providers
Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.
Human-readable name for an Organization.
Unique identifier for a given User.
Human-readable name for a User.
Unique identifier for the created API key.
HPKE encrypted credential bundle
A list of private key unique identifiers that were removed
A list of wallet unique identifiers that were removed
Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.
Human-readable name for an Organization.
Unique identifier for a given User.
Human-readable name for a User.
Unique identifier for the created API key.
HPKE encrypted credential bundle
Unique identifier of the sub organization that was removed
Unique identifier for an OTP authentication
A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
Unique identifier for a given Vote object.
Unique identifier for a given User.
Unique identifier for a given User.
Human-readable name for a User.
A list of Authenticator parameters.
Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).
AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID Identifier indicating the type of the Security Key.
Unique identifier for a WebAuthn credential.
The type of Authenticator device.
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.
Unique identifier for a given API Key.
Human-readable name for an API Key.
Optional window (in seconds) indicating how long the API Key should last.
A list of User Tag IDs.
A list of Oauth Providers.
Unique identifier for an OAuth Provider
Human-readable name to identify a Provider.
The issuer of the token, typically a URL indicating the authentication server, e.g https://accounts.google.com
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
The user's email address.
The user's phone number in E.164 format e.g. +13214567890
Unique identifier for a given Activity object.
VOTE_SELECTION_APPROVED, VOTE_SELECTION_REJECTED The raw message being signed within a Vote.
The public component of a cryptographic key pair used to sign messages and transactions.
The signature applied to a particular vote.
Method used to produce a signature.
An artifact verifying a User's action.
Was this page helpful?
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/oauth \
--header 'Content-Type: application/json' \
--header 'X-Stamp: <api-key>' \
--data '{
"type": "ACTIVITY_TYPE_OAUTH",
"timestampMs": "<string>",
"organizationId": "<string>",
"parameters": {
"oidcToken": "<string>",
"targetPublicKey": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
}
}'{
"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>"
]
}
]
},
"createPrivateKeysIntent": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "CURVE_SECP256K1",
"privateKeyTags": [
"<string>"
],
"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>"
],
"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>"
]
},
"deleteAuthenticatorsIntent": {
"userId": "<string>",
"authenticatorIds": [
"<string>"
]
},
"deleteInvitationIntent": {
"invitationId": "<string>"
},
"deleteOrganizationIntent": {
"organizationId": "<string>"
},
"deletePolicyIntent": {
"policyId": "<string>"
},
"createUserTagIntent": {
"userTagName": "<string>",
"userIds": [
"<string>"
]
},
"deleteUserTagsIntent": {
"userTagIds": [
"<string>"
]
},
"signTransactionIntent": {
"privateKeyId": "<string>",
"unsignedTransaction": "<string>",
"type": "TRANSACTION_TYPE_ETHEREUM"
},
"createApiKeysIntent": {
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
],
"userId": "<string>"
},
"deleteApiKeysIntent": {
"userId": "<string>",
"apiKeyIds": [
"<string>"
]
},
"approveActivityIntent": {
"fingerprint": "<string>"
},
"rejectActivityIntent": {
"fingerprint": "<string>"
},
"createPrivateKeyTagIntent": {
"privateKeyTagName": "<string>",
"privateKeyIds": [
"<string>"
]
},
"deletePrivateKeyTagsIntent": {
"privateKeyTagIds": [
"<string>"
]
},
"createPolicyIntentV2": {
"policyName": "<string>",
"selectors": [
{
"subject": "<string>",
"operator": "OPERATOR_EQUAL",
"targets": [
"<string>"
]
}
],
"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>"
],
"apiKeys": [
{
"apiKeyName": "<string>",
"publicKey": "<string>",
"expirationSeconds": "<string>"
}
]
}
]
},
"updateRootQuorumIntent": {
"threshold": 123,
"userIds": [
"<string>"
]
},
"updateUserTagIntent": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string>"
],
"removeUserIds": [
"<string>"
]
},
"updatePrivateKeyTagIntent": {
"privateKeyTagId": "<string>",
"newPrivateKeyTagName": "<string>",
"addPrivateKeyIds": [
"<string>"
],
"removePrivateKeyIds": [
"<string>"
]
},
"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>"
]
}
]
},
"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>"
]
},
"createPrivateKeysIntentV2": {
"privateKeys": [
{
"privateKeyName": "<string>",
"curve": "CURVE_SECP256K1",
"privateKeyTags": [
"<string>"
],
"addressFormats": [
"ADDRESS_FORMAT_UNCOMPRESSED"
]
}
]
},
"updateUserIntent": {
"userId": "<string>",
"userName": "<string>",
"userEmail": "<string>",
"userTagIds": [
"<string>"
],
"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>"
],
"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>"
},
"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>"
],
"encoding": "PAYLOAD_ENCODING_HEXADECIMAL",
"hashFunction": "HASH_FUNCTION_NO_OP"
},
"createReadOnlySessionIntent": {},
"createOauthProvidersIntent": {
"userId": "<string>",
"oauthProviders": [
{
"providerName": "<string>",
"oidcToken": "<string>"
}
]
},
"deleteOauthProvidersIntent": {
"userId": "<string>",
"providerIds": [
"<string>"
]
},
"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>"
},
"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>"
},
"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>"
],
"deleteWithoutExport": true
},
"deleteWalletsIntent": {
"walletIds": [
"<string>"
],
"deleteWithoutExport": true
},
"createReadWriteSessionIntentV2": {
"targetPublicKey": "<string>",
"userId": "<string>",
"apiKeyName": "<string>",
"expirationSeconds": "<string>"
},
"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>"
},
"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>"
}
},
"result": {
"createOrganizationResult": {
"organizationId": "<string>"
},
"createAuthenticatorsResult": {
"authenticatorIds": [
"<string>"
]
},
"createUsersResult": {
"userIds": [
"<string>"
]
},
"createPrivateKeysResult": {
"privateKeyIds": [
"<string>"
]
},
"createInvitationsResult": {
"invitationIds": [
"<string>"
]
},
"acceptInvitationResult": {
"invitationId": "<string>",
"userId": "<string>"
},
"signRawPayloadResult": {
"r": "<string>",
"s": "<string>",
"v": "<string>"
},
"createPolicyResult": {
"policyId": "<string>"
},
"disablePrivateKeyResult": {
"privateKeyId": "<string>"
},
"deleteUsersResult": {
"userIds": [
"<string>"
]
},
"deleteAuthenticatorsResult": {
"authenticatorIds": [
"<string>"
]
},
"deleteInvitationResult": {
"invitationId": "<string>"
},
"deleteOrganizationResult": {
"organizationId": "<string>"
},
"deletePolicyResult": {
"policyId": "<string>"
},
"createUserTagResult": {
"userTagId": "<string>",
"userIds": [
"<string>"
]
},
"deleteUserTagsResult": {
"userTagIds": [
"<string>"
],
"userIds": [
"<string>"
]
},
"signTransactionResult": {
"signedTransaction": "<string>"
},
"deleteApiKeysResult": {
"apiKeyIds": [
"<string>"
]
},
"createApiKeysResult": {
"apiKeyIds": [
"<string>"
]
},
"createPrivateKeyTagResult": {
"privateKeyTagId": "<string>",
"privateKeyIds": [
"<string>"
]
},
"deletePrivateKeyTagsResult": {
"privateKeyTagIds": [
"<string>"
],
"privateKeyIds": [
"<string>"
]
},
"setPaymentMethodResult": {
"lastFour": "<string>",
"cardHolderName": "<string>",
"cardHolderEmail": "<string>"
},
"activateBillingTierResult": {
"productId": "<string>"
},
"deletePaymentMethodResult": {
"paymentMethodId": "<string>"
},
"createApiOnlyUsersResult": {
"userIds": [
"<string>"
]
},
"updateRootQuorumResult": {},
"updateUserTagResult": {
"userTagId": "<string>"
},
"updatePrivateKeyTagResult": {
"privateKeyTagId": "<string>"
},
"createSubOrganizationResult": {
"subOrganizationId": "<string>",
"rootUserIds": [
"<string>"
]
},
"updateAllowedOriginsResult": {},
"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>"
]
},
"createWalletResult": {
"walletId": "<string>",
"addresses": [
"<string>"
]
},
"createWalletAccountsResult": {
"addresses": [
"<string>"
]
},
"initUserEmailRecoveryResult": {
"userId": "<string>"
},
"recoverUserResult": {
"authenticatorId": [
"<string>"
]
},
"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>"
]
},
"rootUserIds": [
"<string>"
]
},
"emailAuthResult": {
"userId": "<string>",
"apiKeyId": "<string>"
},
"exportWalletAccountResult": {
"address": "<string>",
"exportBundle": "<string>"
},
"initImportWalletResult": {
"importBundle": "<string>"
},
"importWalletResult": {
"walletId": "<string>",
"addresses": [
"<string>"
]
},
"initImportPrivateKeyResult": {
"importBundle": "<string>"
},
"importPrivateKeyResult": {
"privateKeyId": "<string>",
"addresses": [
{
"format": "ADDRESS_FORMAT_UNCOMPRESSED",
"address": "<string>"
}
]
},
"createPoliciesResult": {
"policyIds": [
"<string>"
]
},
"signRawPayloadsResult": {
"signatures": [
{
"r": "<string>",
"s": "<string>",
"v": "<string>"
}
]
},
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
},
"createOauthProvidersResult": {
"providerIds": [
"<string>"
]
},
"deleteOauthProvidersResult": {
"providerIds": [
"<string>"
]
},
"createSubOrganizationResultV5": {
"subOrganizationId": "<string>",
"wallet": {
"walletId": "<string>",
"addresses": [
"<string>"
]
},
"rootUserIds": [
"<string>"
]
},
"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>"
]
},
"rootUserIds": [
"<string>"
]
},
"deletePrivateKeysResult": {
"privateKeyIds": [
"<string>"
]
},
"deleteWalletsResult": {
"walletIds": [
"<string>"
]
},
"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>"
]
},
"rootUserIds": [
"<string>"
]
},
"updateWalletResult": {
"walletId": "<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>"
],
"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>"
}
]
}
}
}