--- title: "Perform email auth" method: POST path: "/public/v1/submit/email_auth" tags: ["User Auth"] --- # Perform email auth `POST /public/v1/submit/email_auth` Authenticate a user via email. ## Request body - V1EmailAuthRequest - `type` 'ACTIVITY_TYPE_EMAIL_AUTH_V2', required - `timestampMs` string, required — Timestamp (in milliseconds) of the request, used to verify liveness of user requests. - `organizationId` string, required — Unique identifier for a given Organization. - `parameters` V1EmailAuthIntentV2, required - `email` string, required — Email of the authenticating user. - `targetPublicKey` string, required — Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted. - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to Email Auth - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `invalidateExisting` boolean — Invalidate all other previously generated Email Auth API keys - `sendFromEmailAddress` string — Optional custom email address from which to send the email - `sendFromEmailSenderName` string — Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' - `replyToEmailAddress` string — Optional custom email address to use as reply-to ## Response `200` A successful response. - V1ActivityResponse - `activity` V1Activity, required - `id` string, required — Unique identifier for a given Activity object. - `organizationId` string, required — Unique identifier for a given Organization. - `status` 'ACTIVITY_STATUS_CREATED' | 'ACTIVITY_STATUS_PENDING' | 'ACTIVITY_STATUS_COMPLETED' | 'ACTIVITY_STATUS_FAILED' | 'ACTIVITY_STATUS_CONSENSUS_NEEDED' | 'ACTIVITY_STATUS_REJECTED', required - `type` 'ACTIVITY_TYPE_CREATE_API_KEYS' | 'ACTIVITY_TYPE_CREATE_USERS' | 'ACTIVITY_TYPE_CREATE_PRIVATE_KEYS' | 'ACTIVITY_TYPE_SIGN_RAW_PAYLOAD' | 'ACTIVITY_TYPE_CREATE_INVITATIONS' | 'ACTIVITY_TYPE_ACCEPT_INVITATION' | 'ACTIVITY_TYPE_CREATE_POLICY' | 'ACTIVITY_TYPE_DISABLE_PRIVATE_KEY' | 'ACTIVITY_TYPE_DELETE_USERS' | 'ACTIVITY_TYPE_DELETE_API_KEYS' | 'ACTIVITY_TYPE_DELETE_INVITATION' | 'ACTIVITY_TYPE_DELETE_ORGANIZATION' | 'ACTIVITY_TYPE_DELETE_POLICY' | 'ACTIVITY_TYPE_CREATE_USER_TAG' | 'ACTIVITY_TYPE_DELETE_USER_TAGS' | 'ACTIVITY_TYPE_CREATE_ORGANIZATION' | 'ACTIVITY_TYPE_SIGN_TRANSACTION' | 'ACTIVITY_TYPE_APPROVE_ACTIVITY' | 'ACTIVITY_TYPE_REJECT_ACTIVITY' | 'ACTIVITY_TYPE_DELETE_AUTHENTICATORS' | 'ACTIVITY_TYPE_CREATE_AUTHENTICATORS' | 'ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG' | 'ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS' | 'ACTIVITY_TYPE_SET_PAYMENT_METHOD' | 'ACTIVITY_TYPE_ACTIVATE_BILLING_TIER' | 'ACTIVITY_TYPE_DELETE_PAYMENT_METHOD' | 'ACTIVITY_TYPE_CREATE_POLICY_V2' | 'ACTIVITY_TYPE_CREATE_POLICY_V3' | 'ACTIVITY_TYPE_CREATE_API_ONLY_USERS' | 'ACTIVITY_TYPE_UPDATE_ROOT_QUORUM' | 'ACTIVITY_TYPE_UPDATE_USER_TAG' | 'ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG' | 'ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2' | 'ACTIVITY_TYPE_CREATE_ORGANIZATION_V2' | 'ACTIVITY_TYPE_CREATE_USERS_V2' | 'ACTIVITY_TYPE_ACCEPT_INVITATION_V2' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2' | 'ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS' | 'ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2' | 'ACTIVITY_TYPE_UPDATE_USER' | 'ACTIVITY_TYPE_UPDATE_POLICY' | 'ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3' | 'ACTIVITY_TYPE_CREATE_WALLET' | 'ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS' | 'ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY' | 'ACTIVITY_TYPE_RECOVER_USER' | 'ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE' | 'ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE' | 'ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2' | 'ACTIVITY_TYPE_SIGN_TRANSACTION_V2' | 'ACTIVITY_TYPE_EXPORT_PRIVATE_KEY' | 'ACTIVITY_TYPE_EXPORT_WALLET' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4' | 'ACTIVITY_TYPE_EMAIL_AUTH' | 'ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT' | 'ACTIVITY_TYPE_INIT_IMPORT_WALLET' | 'ACTIVITY_TYPE_IMPORT_WALLET' | 'ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY' | 'ACTIVITY_TYPE_IMPORT_PRIVATE_KEY' | 'ACTIVITY_TYPE_CREATE_POLICIES' | 'ACTIVITY_TYPE_SIGN_RAW_PAYLOADS' | 'ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION' | 'ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS' | 'ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5' | 'ACTIVITY_TYPE_OAUTH' | 'ACTIVITY_TYPE_CREATE_API_KEYS_V2' | 'ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION' | 'ACTIVITY_TYPE_EMAIL_AUTH_V2' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6' | 'ACTIVITY_TYPE_DELETE_PRIVATE_KEYS' | 'ACTIVITY_TYPE_DELETE_WALLETS' | 'ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2' | 'ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION' | 'ACTIVITY_TYPE_INIT_OTP_AUTH' | 'ACTIVITY_TYPE_OTP_AUTH' | 'ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7' | 'ACTIVITY_TYPE_UPDATE_WALLET' | 'ACTIVITY_TYPE_UPDATE_POLICY_V2' | 'ACTIVITY_TYPE_CREATE_USERS_V3' | 'ACTIVITY_TYPE_INIT_OTP_AUTH_V2' | 'ACTIVITY_TYPE_INIT_OTP' | 'ACTIVITY_TYPE_VERIFY_OTP' | 'ACTIVITY_TYPE_OTP_LOGIN' | 'ACTIVITY_TYPE_STAMP_LOGIN' | 'ACTIVITY_TYPE_OAUTH_LOGIN' | 'ACTIVITY_TYPE_UPDATE_USER_NAME' | 'ACTIVITY_TYPE_UPDATE_USER_EMAIL' | 'ACTIVITY_TYPE_UPDATE_USER_PHONE_NUMBER' | 'ACTIVITY_TYPE_INIT_FIAT_ON_RAMP' | 'ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE' | 'ACTIVITY_TYPE_DELETE_SMART_CONTRACT_INTERFACE' | 'ACTIVITY_TYPE_ENABLE_AUTH_PROXY' | 'ACTIVITY_TYPE_DISABLE_AUTH_PROXY' | 'ACTIVITY_TYPE_UPDATE_AUTH_PROXY_CONFIG', required - `intent` V1Intent, required - `createOrganizationIntent` V1CreateOrganizationIntent - `organizationName` string, required — Human-readable name for an Organization. - `rootEmail` string, required — The root user's email address. - `rootAuthenticator` V1AuthenticatorParams, required - `authenticatorName` string, required — Human-readable name for an Authenticator. - `userId` string, required — Unique identifier for a given User. - `attestation` V1PublicKeyCredentialWithAttestation, required - `id` string, required - `type` 'public-key', required - `rawId` string, required - `authenticatorAttachment` 'cross-platform' | 'platform', nullable - `response` V1AuthenticatorAttestationResponse, required - … - `clientExtensionResults` V1SimpleClientExtensionResults, required - … - `challenge` string, required — Challenge presented for authentication purposes. - `rootUserId` string — Unique identifier for the root user object. - `createAuthenticatorsIntent` V1CreateAuthenticatorsIntent - `authenticators` V1AuthenticatorParams[], required — A list of Authenticators. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `userId` string, required — Unique identifier for a given User. - `attestation` V1PublicKeyCredentialWithAttestation, required - `id` string, required - `type` 'public-key', required - `rawId` string, required - `authenticatorAttachment` 'cross-platform' | 'platform', nullable - `response` V1AuthenticatorAttestationResponse, required - … - `clientExtensionResults` V1SimpleClientExtensionResults, required - … - `challenge` string, required — Challenge presented for authentication purposes. - `userId` string, required — Unique identifier for a given User. - `createUsersIntent` V1CreateUsersIntent - `users` V1UserParams[], required — A list of Users. - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `accessType` 'ACCESS_TYPE_WEB' | 'ACCESS_TYPE_API' | 'ACCESS_TYPE_ALL', required - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParams[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `userId` string, required — Unique identifier for a given User. - `attestation` V1PublicKeyCredentialWithAttestation, required - … - `challenge` string, required — Challenge presented for authentication purposes. - `userTags` string[], required — A list of User Tag IDs. This field, if not needed, should be an empty array in your request body. - `createPrivateKeysIntent` V1CreatePrivateKeysIntent - `privateKeys` V1PrivateKeyParams[], required — A list of Private Keys. - `privateKeyName` string, required — Human-readable name for a Private Key. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `privateKeyTags` string[], required — A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body. - `addressFormats` V1AddressFormat[], required — Cryptocurrency-specific formats for a derived address (e.g., Ethereum). - `signRawPayloadIntent` V1SignRawPayloadIntent - `privateKeyId` string, required — Unique identifier for a given Private Key. - `payload` string, required — Raw unsigned payload to be signed. - `encoding` 'PAYLOAD_ENCODING_HEXADECIMAL' | 'PAYLOAD_ENCODING_TEXT_UTF8' | 'PAYLOAD_ENCODING_EIP712', required - `hashFunction` 'HASH_FUNCTION_NO_OP' | 'HASH_FUNCTION_SHA256' | 'HASH_FUNCTION_KECCAK256' | 'HASH_FUNCTION_NOT_APPLICABLE', required - `createInvitationsIntent` V1CreateInvitationsIntent - `invitations` V1InvitationParams[], required — A list of Invitations. - `receiverUserName` string, required — The name of the intended Invitation recipient. - `receiverUserEmail` string, required — The email address of the intended Invitation recipient. - `receiverUserTags` string[], required — A list of tags assigned to the Invitation recipient. This field, if not needed, should be an empty array in your request body. - `accessType` 'ACCESS_TYPE_WEB' | 'ACCESS_TYPE_API' | 'ACCESS_TYPE_ALL', required - `senderUserId` string, required — Unique identifier for the Sender of an Invitation. - `acceptInvitationIntent` V1AcceptInvitationIntent - `invitationId` string, required — Unique identifier for a given Invitation object. - `userId` string, required — Unique identifier for a given User. - `authenticator` V1AuthenticatorParams, required - `authenticatorName` string, required — Human-readable name for an Authenticator. - `userId` string, required — Unique identifier for a given User. - `attestation` V1PublicKeyCredentialWithAttestation, required - `id` string, required - `type` 'public-key', required - `rawId` string, required - `authenticatorAttachment` 'cross-platform' | 'platform', nullable - `response` V1AuthenticatorAttestationResponse, required - … - `clientExtensionResults` V1SimpleClientExtensionResults, required - … - `challenge` string, required — Challenge presented for authentication purposes. - `createPolicyIntent` V1CreatePolicyIntent - `policyName` string, required — Human-readable name for a Policy. - `selectors` V1Selector[], required — A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. - `subject` string - `operator` 'OPERATOR_EQUAL' | 'OPERATOR_MORE_THAN' | 'OPERATOR_MORE_THAN_OR_EQUAL' | 'OPERATOR_LESS_THAN' | 'OPERATOR_LESS_THAN_OR_EQUAL' | 'OPERATOR_CONTAINS' | 'OPERATOR_NOT_EQUAL' | 'OPERATOR_IN' | 'OPERATOR_NOT_IN' | 'OPERATOR_CONTAINS_ONE' | 'OPERATOR_CONTAINS_ALL' - `target` string - `effect` 'EFFECT_ALLOW' | 'EFFECT_DENY', required - `notes` string - `disablePrivateKeyIntent` V1DisablePrivateKeyIntent - `privateKeyId` string, required — Unique identifier for a given Private Key. - `deleteUsersIntent` V1DeleteUsersIntent - `userIds` string[], required — A list of User IDs. - `deleteAuthenticatorsIntent` V1DeleteAuthenticatorsIntent - `userId` string, required — Unique identifier for a given User. - `authenticatorIds` string[], required — A list of Authenticator IDs. - `deleteInvitationIntent` V1DeleteInvitationIntent - `invitationId` string, required — Unique identifier for a given Invitation object. - `deleteOrganizationIntent` V1DeleteOrganizationIntent - `organizationId` string, required — Unique identifier for a given Organization. - `deletePolicyIntent` V1DeletePolicyIntent - `policyId` string, required — Unique identifier for a given Policy. - `createUserTagIntent` V1CreateUserTagIntent - `userTagName` string, required — Human-readable name for a User Tag. - `userIds` string[], required — A list of User IDs. - `deleteUserTagsIntent` V1DeleteUserTagsIntent - `userTagIds` string[], required — A list of User Tag IDs. - `signTransactionIntent` V1SignTransactionIntent - `privateKeyId` string, required — Unique identifier for a given Private Key. - `unsignedTransaction` string, required — Raw unsigned transaction to be signed by a particular Private Key. - `type` 'TRANSACTION_TYPE_ETHEREUM' | 'TRANSACTION_TYPE_SOLANA' | 'TRANSACTION_TYPE_TRON', required - `createApiKeysIntent` V1CreateApiKeysIntent - `apiKeys` ApiApiKeyParams[], required — A list of API Keys. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `userId` string, required — Unique identifier for a given User. - `deleteApiKeysIntent` V1DeleteApiKeysIntent - `userId` string, required — Unique identifier for a given User. - `apiKeyIds` string[], required — A list of API Key IDs. - `approveActivityIntent` V1ApproveActivityIntent - `fingerprint` string, required — An artifact verifying a User's action. - `rejectActivityIntent` V1RejectActivityIntent - `fingerprint` string, required — An artifact verifying a User's action. - `createPrivateKeyTagIntent` V1CreatePrivateKeyTagIntent - `privateKeyTagName` string, required — Human-readable name for a Private Key Tag. - `privateKeyIds` string[], required — A list of Private Key IDs. - `deletePrivateKeyTagsIntent` V1DeletePrivateKeyTagsIntent - `privateKeyTagIds` string[], required — A list of Private Key Tag IDs. - `createPolicyIntentV2` V1CreatePolicyIntentV2 - `policyName` string, required — Human-readable name for a Policy. - `selectors` V1SelectorV2[], required — A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details. - `subject` string - `operator` 'OPERATOR_EQUAL' | 'OPERATOR_MORE_THAN' | 'OPERATOR_MORE_THAN_OR_EQUAL' | 'OPERATOR_LESS_THAN' | 'OPERATOR_LESS_THAN_OR_EQUAL' | 'OPERATOR_CONTAINS' | 'OPERATOR_NOT_EQUAL' | 'OPERATOR_IN' | 'OPERATOR_NOT_IN' | 'OPERATOR_CONTAINS_ONE' | 'OPERATOR_CONTAINS_ALL' - `targets` string[] - `effect` 'EFFECT_ALLOW' | 'EFFECT_DENY', required - `notes` string - `setPaymentMethodIntent` BillingSetPaymentMethodIntent - `number` string, required — The account number of the customer's credit card. - `cvv` string, required — The verification digits of the customer's credit card. - `expiryMonth` string, required — The month that the credit card expires. - `expiryYear` string, required — The year that the credit card expires. - `cardHolderEmail` string, required — The email that will receive invoices for the credit card. - `cardHolderName` string, required — The name associated with the credit card. - `activateBillingTierIntent` BillingActivateBillingTierIntent - `productId` string, required — The product that the customer wants to subscribe to. - `deletePaymentMethodIntent` BillingDeletePaymentMethodIntent - `paymentMethodId` string, required — The payment method that the customer wants to remove. - `createPolicyIntentV3` V1CreatePolicyIntentV3 - `policyName` string, required — Human-readable name for a Policy. - `effect` 'EFFECT_ALLOW' | 'EFFECT_DENY', required - `condition` string — The condition expression that triggers the Effect - `consensus` string — The consensus expression that triggers the Effect - `notes` string - `createApiOnlyUsersIntent` V1CreateApiOnlyUsersIntent - `apiOnlyUsers` V1ApiOnlyUserParams[], required — A list of API-only Users to create. - `userName` string, required — The name of the new API-only User. - `userEmail` string — The email address for this API-only User (optional). - `userTags` string[], required — 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. - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `updateRootQuorumIntent` V1UpdateRootQuorumIntent - `threshold` integer, required — The threshold of unique approvals to reach quorum. - `userIds` string[], required — The unique identifiers of users who comprise the quorum set. - `updateUserTagIntent` V1UpdateUserTagIntent - `userTagId` string, required — Unique identifier for a given User Tag. - `newUserTagName` string — The new, human-readable name for the tag with the given ID. - `addUserIds` string[], required — A list of User IDs to add this tag to. - `removeUserIds` string[], required — A list of User IDs to remove this tag from. - `updatePrivateKeyTagIntent` V1UpdatePrivateKeyTagIntent - `privateKeyTagId` string, required — Unique identifier for a given Private Key Tag. - `newPrivateKeyTagName` string — The new, human-readable name for the tag with the given ID. - `addPrivateKeyIds` string[], required — A list of Private Keys IDs to add this tag to. - `removePrivateKeyIds` string[], required — A list of Private Key IDs to remove this tag from. - `createAuthenticatorsIntentV2` V1CreateAuthenticatorsIntentV2 - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticators. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - `credentialId` string, required — The cbor encoded then base64 url encoded id of the credential. - `clientDataJson` string, required — A base64 url encoded payload containing metadata about the signing context and the challenge. - `attestationObject` string, required — A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. - `transports` V1AuthenticatorTransport[], required — The type of authenticator transports. - `userId` string, required — Unique identifier for a given User. - `acceptInvitationIntentV2` V1AcceptInvitationIntentV2 - `invitationId` string, required — Unique identifier for a given Invitation object. - `userId` string, required — Unique identifier for a given User. - `authenticator` V1AuthenticatorParamsV2, required - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - `credentialId` string, required — The cbor encoded then base64 url encoded id of the credential. - `clientDataJson` string, required — A base64 url encoded payload containing metadata about the signing context and the challenge. - `attestationObject` string, required — A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. - `transports` V1AuthenticatorTransport[], required — The type of authenticator transports. - `createOrganizationIntentV2` V1CreateOrganizationIntentV2 - `organizationName` string, required — Human-readable name for an Organization. - `rootEmail` string, required — The root user's email address. - `rootAuthenticator` V1AuthenticatorParamsV2, required - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - `credentialId` string, required — The cbor encoded then base64 url encoded id of the credential. - `clientDataJson` string, required — A base64 url encoded payload containing metadata about the signing context and the challenge. - `attestationObject` string, required — A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. - `transports` V1AuthenticatorTransport[], required — The type of authenticator transports. - `rootUserId` string — Unique identifier for the root user object. - `createUsersIntentV2` V1CreateUsersIntentV2 - `users` V1UserParamsV2[], required — A list of Users. - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `userTags` string[], required — A list of User Tag IDs. This field, if not needed, should be an empty array in your request body. - `createSubOrganizationIntent` V1CreateSubOrganizationIntent - `name` string, required — Name for this sub-organization - `rootAuthenticator` V1AuthenticatorParamsV2, required - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - `credentialId` string, required — The cbor encoded then base64 url encoded id of the credential. - `clientDataJson` string, required — A base64 url encoded payload containing metadata about the signing context and the challenge. - `attestationObject` string, required — A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. - `transports` V1AuthenticatorTransport[], required — The type of authenticator transports. - `createSubOrganizationIntentV2` V1CreateSubOrganizationIntentV2 - `subOrganizationName` string, required — Name for this sub-organization - `rootUsers` V1RootUserParams[], required — Root users to create within this sub-organization - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `rootQuorumThreshold` integer, required — The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users - `updateAllowedOriginsIntent` V1UpdateAllowedOriginsIntent - `allowedOrigins` string[], required — Additional origins requests are allowed from besides Turnkey origins - `createPrivateKeysIntentV2` V1CreatePrivateKeysIntentV2 - `privateKeys` V1PrivateKeyParams[], required — A list of Private Keys. - `privateKeyName` string, required — Human-readable name for a Private Key. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `privateKeyTags` string[], required — A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body. - `addressFormats` V1AddressFormat[], required — Cryptocurrency-specific formats for a derived address (e.g., Ethereum). - `updateUserIntent` V1UpdateUserIntent - `userId` string, required — Unique identifier for a given User. - `userName` string — Human-readable name for a User. - `userEmail` string — The user's email address. - `userTagIds` string[] — 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. - `userPhoneNumber` string — The user's phone number in E.164 format e.g. +13214567890 - `updatePolicyIntent` V1UpdatePolicyIntent - `policyId` string, required — Unique identifier for a given Policy. - `policyName` string — Human-readable name for a Policy. - `policyEffect` 'EFFECT_ALLOW' | 'EFFECT_DENY' - `policyCondition` string — The condition expression that triggers the Effect (optional). - `policyConsensus` string — The consensus expression that triggers the Effect (optional). - `policyNotes` string — Accompanying notes for a Policy (optional). - `setPaymentMethodIntentV2` BillingSetPaymentMethodIntentV2 - `paymentMethodId` string, required — The id of the payment method that was created clientside. - `cardHolderEmail` string, required — The email that will receive invoices for the credit card. - `cardHolderName` string, required — The name associated with the credit card. - `createSubOrganizationIntentV3` V1CreateSubOrganizationIntentV3 - `subOrganizationName` string, required — Name for this sub-organization - `rootUsers` V1RootUserParams[], required — Root users to create within this sub-organization - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `rootQuorumThreshold` integer, required — The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users - `privateKeys` V1PrivateKeyParams[], required — A list of Private Keys. - `privateKeyName` string, required — Human-readable name for a Private Key. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `privateKeyTags` string[], required — A list of Private Key Tag IDs. This field, if not needed, should be an empty array in your request body. - `addressFormats` V1AddressFormat[], required — Cryptocurrency-specific formats for a derived address (e.g., Ethereum). - `createWalletIntent` V1CreateWalletIntent - `walletName` string, required — Human-readable name for a Wallet. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. This field, if not needed, should be an empty array in your request body. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `mnemonicLength` integer — Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24. - `createWalletAccountsIntent` V1CreateWalletAccountsIntent - `walletId` string, required — Unique identifier for a given Wallet. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `initUserEmailRecoveryIntent` V1InitUserEmailRecoveryIntent - `email` string, required — Email of the user starting recovery - `targetPublicKey` string, required — Client-side public key generated by the user, to which the recovery bundle will be encrypted. - `expirationSeconds` string — Expiration window (in seconds) indicating how long the recovery credential is valid for. If not provided, a default of 15 minutes will be used. - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `recoverUserIntent` V1RecoverUserIntent - `authenticator` V1AuthenticatorParamsV2, required - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - `credentialId` string, required — The cbor encoded then base64 url encoded id of the credential. - `clientDataJson` string, required — A base64 url encoded payload containing metadata about the signing context and the challenge. - `attestationObject` string, required — A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses. - `transports` V1AuthenticatorTransport[], required — The type of authenticator transports. - `userId` string, required — Unique identifier for the user performing recovery. - `setOrganizationFeatureIntent` V1SetOrganizationFeatureIntent - `name` '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' | 'FEATURE_NAME_AUTH_PROXY', required - `value` string, required — Optional value for the feature. Will override existing values if feature is already set. - `removeOrganizationFeatureIntent` V1RemoveOrganizationFeatureIntent - `name` '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' | 'FEATURE_NAME_AUTH_PROXY', required - `signRawPayloadIntentV2` V1SignRawPayloadIntentV2 - `signWith` string, required — A Wallet account address, Private Key address, or Private Key identifier. - `payload` string, required — Raw unsigned payload to be signed. - `encoding` 'PAYLOAD_ENCODING_HEXADECIMAL' | 'PAYLOAD_ENCODING_TEXT_UTF8' | 'PAYLOAD_ENCODING_EIP712', required - `hashFunction` 'HASH_FUNCTION_NO_OP' | 'HASH_FUNCTION_SHA256' | 'HASH_FUNCTION_KECCAK256' | 'HASH_FUNCTION_NOT_APPLICABLE', required - `signTransactionIntentV2` V1SignTransactionIntentV2 - `signWith` string, required — A Wallet account address, Private Key address, or Private Key identifier. - `unsignedTransaction` string, required — Raw unsigned transaction to be signed - `type` 'TRANSACTION_TYPE_ETHEREUM' | 'TRANSACTION_TYPE_SOLANA' | 'TRANSACTION_TYPE_TRON', required - `exportPrivateKeyIntent` V1ExportPrivateKeyIntent - `privateKeyId` string, required — Unique identifier for a given Private Key. - `targetPublicKey` string, required — Client-side public key generated by the user, to which the export bundle will be encrypted. - `exportWalletIntent` V1ExportWalletIntent - `walletId` string, required — Unique identifier for a given Wallet. - `targetPublicKey` string, required — Client-side public key generated by the user, to which the export bundle will be encrypted. - `language` '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` V1CreateSubOrganizationIntentV4 - `subOrganizationName` string, required — Name for this sub-organization - `rootUsers` V1RootUserParams[], required — Root users to create within this sub-organization - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `rootQuorumThreshold` integer, required — The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users - `wallet` V1WalletParams - `walletName` string, required — Human-readable name for a Wallet. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. This field, if not needed, should be an empty array in your request body. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `mnemonicLength` integer — Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24. - `disableEmailRecovery` boolean — Disable email recovery for the sub-organization - `disableEmailAuth` boolean — Disable email auth for the sub-organization - `emailAuthIntent` V1EmailAuthIntent - `email` string, required — Email of the authenticating user. - `targetPublicKey` string, required — Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted. - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to Email Auth - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `invalidateExisting` boolean — Invalidate all other previously generated Email Auth API keys - `sendFromEmailAddress` string — Optional custom email address from which to send the email - `sendFromEmailSenderName` string — Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' - `replyToEmailAddress` string — Optional custom email address to use as reply-to - `exportWalletAccountIntent` V1ExportWalletAccountIntent - `address` string, required — Address to identify Wallet Account. - `targetPublicKey` string, required — Client-side public key generated by the user, to which the export bundle will be encrypted. - `initImportWalletIntent` V1InitImportWalletIntent - `userId` string, required — The ID of the User importing a Wallet. - `importWalletIntent` V1ImportWalletIntent - `userId` string, required — The ID of the User importing a Wallet. - `walletName` string, required — Human-readable name for a Wallet. - `encryptedBundle` string, required — Bundle containing a wallet mnemonic encrypted to the enclave's target public key. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `initImportPrivateKeyIntent` V1InitImportPrivateKeyIntent - `userId` string, required — The ID of the User importing a Private Key. - `importPrivateKeyIntent` V1ImportPrivateKeyIntent - `userId` string, required — The ID of the User importing a Private Key. - `privateKeyName` string, required — Human-readable name for a Private Key. - `encryptedBundle` string, required — Bundle containing a raw private key encrypted to the enclave's target public key. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `addressFormats` V1AddressFormat[], required — Cryptocurrency-specific formats for a derived address (e.g., Ethereum). - `createPoliciesIntent` V1CreatePoliciesIntent - `policies` V1CreatePolicyIntentV3[], required — An array of policy intents to be created. - `policyName` string, required — Human-readable name for a Policy. - `effect` 'EFFECT_ALLOW' | 'EFFECT_DENY', required - `condition` string — The condition expression that triggers the Effect - `consensus` string — The consensus expression that triggers the Effect - `notes` string - `signRawPayloadsIntent` V1SignRawPayloadsIntent - `signWith` string, required — A Wallet account address, Private Key address, or Private Key identifier. - `payloads` string[], required — An array of raw unsigned payloads to be signed. - `encoding` 'PAYLOAD_ENCODING_HEXADECIMAL' | 'PAYLOAD_ENCODING_TEXT_UTF8' | 'PAYLOAD_ENCODING_EIP712', required - `hashFunction` 'HASH_FUNCTION_NO_OP' | 'HASH_FUNCTION_SHA256' | 'HASH_FUNCTION_KECCAK256' | 'HASH_FUNCTION_NOT_APPLICABLE', required - `createReadOnlySessionIntent` V1CreateReadOnlySessionIntent - `createOauthProvidersIntent` V1CreateOauthProvidersIntent - `userId` string, required — The ID of the User to add an Oauth provider to - `oauthProviders` V1OauthProviderParams[], required — A list of Oauth providers. - `providerName` string, required — Human-readable name to identify a Provider. - `oidcToken` string, required — Base64 encoded OIDC token - `deleteOauthProvidersIntent` V1DeleteOauthProvidersIntent - `userId` string, required — The ID of the User to remove an Oauth provider from - `providerIds` string[], required — Unique identifier for a given Provider. - `createSubOrganizationIntentV5` V1CreateSubOrganizationIntentV5 - `subOrganizationName` string, required — Name for this sub-organization - `rootUsers` V1RootUserParamsV2[], required — Root users to create within this sub-organization - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `apiKeys` ApiApiKeyParams[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `oauthProviders` V1OauthProviderParams[], required — A list of Oauth providers. This field, if not needed, should be an empty array in your request body. - `providerName` string, required — Human-readable name to identify a Provider. - `oidcToken` string, required — Base64 encoded OIDC token - `rootQuorumThreshold` integer, required — The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users - `wallet` V1WalletParams - `walletName` string, required — Human-readable name for a Wallet. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. This field, if not needed, should be an empty array in your request body. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `mnemonicLength` integer — Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24. - `disableEmailRecovery` boolean — Disable email recovery for the sub-organization - `disableEmailAuth` boolean — Disable email auth for the sub-organization - `oauthIntent` V1OauthIntent - `oidcToken` string, required — Base64 encoded OIDC token - `targetPublicKey` string, required — Client-side public key generated by the user, to which the oauth bundle (credentials) will be encrypted. - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to Oauth - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `invalidateExisting` boolean — Invalidate all other previously generated Oauth API keys - `createApiKeysIntentV2` V1CreateApiKeysIntentV2 - `apiKeys` V1ApiKeyParamsV2[], required — A list of API Keys. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `curveType` 'API_KEY_CURVE_P256' | 'API_KEY_CURVE_SECP256K1' | 'API_KEY_CURVE_ED25519', required - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `userId` string, required — Unique identifier for a given User. - `createReadWriteSessionIntent` V1CreateReadWriteSessionIntent - `targetPublicKey` string, required — Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted. - `email` string, required — Email of the user to create a read write session for - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to Read Write Session - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `emailAuthIntentV2` V1EmailAuthIntentV2 - `email` string, required — Email of the authenticating user. - `targetPublicKey` string, required — Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted. - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to Email Auth - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `invalidateExisting` boolean — Invalidate all other previously generated Email Auth API keys - `sendFromEmailAddress` string — Optional custom email address from which to send the email - `sendFromEmailSenderName` string — Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' - `replyToEmailAddress` string — Optional custom email address to use as reply-to - `createSubOrganizationIntentV6` V1CreateSubOrganizationIntentV6 - `subOrganizationName` string, required — Name for this sub-organization - `rootUsers` V1RootUserParamsV3[], required — Root users to create within this sub-organization - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `apiKeys` V1ApiKeyParamsV2[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `curveType` 'API_KEY_CURVE_P256' | 'API_KEY_CURVE_SECP256K1' | 'API_KEY_CURVE_ED25519', required - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `oauthProviders` V1OauthProviderParams[], required — A list of Oauth providers. This field, if not needed, should be an empty array in your request body. - `providerName` string, required — Human-readable name to identify a Provider. - `oidcToken` string, required — Base64 encoded OIDC token - `rootQuorumThreshold` integer, required — The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users - `wallet` V1WalletParams - `walletName` string, required — Human-readable name for a Wallet. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. This field, if not needed, should be an empty array in your request body. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `mnemonicLength` integer — Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24. - `disableEmailRecovery` boolean — Disable email recovery for the sub-organization - `disableEmailAuth` boolean — Disable email auth for the sub-organization - `deletePrivateKeysIntent` V1DeletePrivateKeysIntent - `privateKeyIds` string[], required — List of unique identifiers for private keys within an organization - `deleteWithoutExport` boolean — Optional parameter for deleting the private keys, even if any have not been previously exported. If they have been exported, this field is ignored. - `deleteWalletsIntent` V1DeleteWalletsIntent - `walletIds` string[], required — List of unique identifiers for wallets within an organization - `deleteWithoutExport` boolean — Optional parameter for deleting the wallets, even if any have not been previously exported. If they have been exported, this field is ignored. - `createReadWriteSessionIntentV2` V1CreateReadWriteSessionIntentV2 - `targetPublicKey` string, required — Client-side public key generated by the user, to which the read write session bundle (credentials) will be encrypted. - `userId` string — Unique identifier for a given User. - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to Read Write Session - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `invalidateExisting` boolean — Invalidate all other previously generated ReadWriteSession API keys - `deleteSubOrganizationIntent` V1DeleteSubOrganizationIntent - `deleteWithoutExport` boolean — 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` V1InitOtpAuthIntent - `otpType` string, required — Enum to specifiy whether to send OTP via SMS or email - `contact` string, required — Email or phone number to send the OTP code to - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `smsCustomization` V1SmsCustomizationParams - `template` string — Template containing references to .OtpCode i.e Your OTP is {{.OtpCode}} - `userIdentifier` string — 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. - `sendFromEmailAddress` string — Optional custom email address from which to send the OTP email - `sendFromEmailSenderName` string — Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' - `replyToEmailAddress` string — Optional custom email address to use as reply-to - `otpAuthIntent` V1OtpAuthIntent - `otpId` string, required — ID representing the result of an init OTP activity. - `otpCode` string, required — OTP sent out to a user's contact (email or SMS) - `targetPublicKey` string, required — Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted. - `apiKeyName` string — Optional human-readable name for an API Key. If none provided, default to OTP Auth - - `expirationSeconds` string — Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used. - `invalidateExisting` boolean — Invalidate all other previously generated OTP Auth API keys - `createSubOrganizationIntentV7` V1CreateSubOrganizationIntentV7 - `subOrganizationName` string, required — Name for this sub-organization - `rootUsers` V1RootUserParamsV4[], required — Root users to create within this sub-organization - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `userPhoneNumber` string — The user's phone number in E.164 format e.g. +13214567890 - `apiKeys` V1ApiKeyParamsV2[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `curveType` 'API_KEY_CURVE_P256' | 'API_KEY_CURVE_SECP256K1' | 'API_KEY_CURVE_ED25519', required - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `oauthProviders` V1OauthProviderParams[], required — A list of Oauth providers. This field, if not needed, should be an empty array in your request body. - `providerName` string, required — Human-readable name to identify a Provider. - `oidcToken` string, required — Base64 encoded OIDC token - `rootQuorumThreshold` integer, required — The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users - `wallet` V1WalletParams - `walletName` string, required — Human-readable name for a Wallet. - `accounts` V1WalletAccountParams[], required — A list of wallet Accounts. This field, if not needed, should be an empty array in your request body. - `curve` 'CURVE_SECP256K1' | 'CURVE_ED25519', required - `pathFormat` 'PATH_FORMAT_BIP32', required - `path` string, required — Path used to generate a wallet Account. - `addressFormat` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP', required - `mnemonicLength` integer — Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24. - `disableEmailRecovery` boolean — Disable email recovery for the sub-organization - `disableEmailAuth` boolean — Disable email auth for the sub-organization - `disableSmsAuth` boolean — Disable OTP SMS auth for the sub-organization - `disableOtpEmailAuth` boolean — Disable OTP email auth for the sub-organization - `verificationToken` string — Signed JWT containing a unique id, expiry, verification type, contact - `updateWalletIntent` V1UpdateWalletIntent - `walletId` string, required — Unique identifier for a given Wallet. - `walletName` string — Human-readable name for a Wallet. - `updatePolicyIntentV2` V1UpdatePolicyIntentV2 - `policyId` string, required — Unique identifier for a given Policy. - `policyName` string — Human-readable name for a Policy. - `policyEffect` 'EFFECT_ALLOW' | 'EFFECT_DENY' - `policyCondition` string — The condition expression that triggers the Effect (optional). - `policyConsensus` string — The consensus expression that triggers the Effect (optional). - `policyNotes` string — Accompanying notes for a Policy (optional). - `createUsersIntentV3` V1CreateUsersIntentV3 - `users` V1UserParamsV3[], required — A list of Users. - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `userPhoneNumber` string — The user's phone number in E.164 format e.g. +13214567890 - `apiKeys` V1ApiKeyParamsV2[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `apiKeyName` string, required — Human-readable name for an API Key. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `curveType` 'API_KEY_CURVE_P256' | 'API_KEY_CURVE_SECP256K1' | 'API_KEY_CURVE_ED25519', required - `expirationSeconds` string — Optional window (in seconds) indicating how long the API Key should last. - `authenticators` V1AuthenticatorParamsV2[], required — A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `challenge` string, required — Challenge presented for authentication purposes. - `attestation` V1Attestation, required - … - `oauthProviders` V1OauthProviderParams[], required — A list of Oauth providers. This field, if not needed, should be an empty array in your request body. - `providerName` string, required — Human-readable name to identify a Provider. - `oidcToken` string, required — Base64 encoded OIDC token - `userTags` string[], required — A list of User Tag IDs. This field, if not needed, should be an empty array in your request body. - `initOtpAuthIntentV2` V1InitOtpAuthIntentV2 - `otpType` string, required — Enum to specifiy whether to send OTP via SMS or email - `contact` string, required — Email or phone number to send the OTP code to - `otpLength` integer — Optional length of the OTP code. Default = 9 - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `smsCustomization` V1SmsCustomizationParams - `template` string — Template containing references to .OtpCode i.e Your OTP is {{.OtpCode}} - `userIdentifier` string — 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. - `sendFromEmailAddress` string — Optional custom email address from which to send the OTP email - `alphanumeric` boolean — Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true - `sendFromEmailSenderName` string — Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' - `replyToEmailAddress` string — Optional custom email address to use as reply-to - `initOtpIntent` V1InitOtpIntent - `otpType` string, required — Whether to send OTP via SMS or email. Possible values: OTP_TYPE_SMS, OTP_TYPE_EMAIL - `contact` string, required — Email or phone number to send the OTP code to - `otpLength` integer — Optional length of the OTP code. Default = 9 - `emailCustomization` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `smsCustomization` V1SmsCustomizationParams - `template` string — Template containing references to .OtpCode i.e Your OTP is {{.OtpCode}} - `userIdentifier` string — 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. - `sendFromEmailAddress` string — Optional custom email address from which to send the OTP email - `alphanumeric` boolean — Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). Default = true - `sendFromEmailSenderName` string — Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications' - `expirationSeconds` string — Expiration window (in seconds) indicating how long the OTP is valid for. If not provided, a default of 5 minutes will be used. Maximum value is 600 seconds (10 minutes) - `replyToEmailAddress` string — Optional custom email address to use as reply-to - `verifyOtpIntent` V1VerifyOtpIntent - `otpId` string, required — ID representing the result of an init OTP activity. - `otpCode` string, required — OTP sent out to a user's contact (email or SMS) - `expirationSeconds` string — Expiration window (in seconds) indicating how long the verification token is valid for. If not provided, a default of 1 hour will be used. Maximum value is 86400 seconds (24 hours) - `otpLoginIntent` V1OtpLoginIntent - `verificationToken` string, required — Signed JWT containing a unique id, expiry, verification type, contact - `publicKey` string, required — Client-side public key generated by the user, which will be conditionally added to org data based on the validity of the verification token - `expirationSeconds` string — Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used. - `invalidateExisting` boolean — Invalidate all other previously generated Login API keys - `stampLoginIntent` V1StampLoginIntent - `publicKey` string, required — Client-side public key generated by the user, which will be conditionally added to org data based on the passkey stamp associated with this request - `expirationSeconds` string — Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used. - `invalidateExisting` boolean — Invalidate all other previously generated Login API keys - `oauthLoginIntent` V1OauthLoginIntent - `oidcToken` string, required — Base64 encoded OIDC token - `publicKey` string, required — Client-side public key generated by the user, which will be conditionally added to org data based on the validity of the oidc token associated with this request - `expirationSeconds` string — Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used. - `invalidateExisting` boolean — Invalidate all other previously generated Login API keys - `updateUserNameIntent` V1UpdateUserNameIntent - `userId` string, required — Unique identifier for a given User. - `userName` string, required — Human-readable name for a User. - `updateUserEmailIntent` V1UpdateUserEmailIntent - `userId` string, required — Unique identifier for a given User. - `userEmail` string, required — The user's email address. Setting this to an empty string will remove the user's email. - `verificationToken` string — Signed JWT containing a unique id, expiry, verification type, contact - `updateUserPhoneNumberIntent` V1UpdateUserPhoneNumberIntent - `userId` string, required — Unique identifier for a given User. - `userPhoneNumber` string, required — The user's phone number in E.164 format e.g. +13214567890. Setting this to an empty string will remove the user's phone number. - `verificationToken` string — Signed JWT containing a unique id, expiry, verification type, contact - `initFiatOnRampIntent` V1InitFiatOnRampIntent - `onrampProvider` 'FIAT_ON_RAMP_PROVIDER_COINBASE' | 'FIAT_ON_RAMP_PROVIDER_MOONPAY', required - `walletAddress` string, required — Destination wallet address for the buy transaction. - `network` 'FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN' | 'FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM' | 'FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA' | 'FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE', required - `cryptoCurrencyCode` 'FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC' | 'FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH' | 'FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL' | 'FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC', required - `fiatCurrencyCode` 'FIAT_ON_RAMP_CURRENCY_AUD' | 'FIAT_ON_RAMP_CURRENCY_BGN' | 'FIAT_ON_RAMP_CURRENCY_BRL' | 'FIAT_ON_RAMP_CURRENCY_CAD' | 'FIAT_ON_RAMP_CURRENCY_CHF' | 'FIAT_ON_RAMP_CURRENCY_COP' | 'FIAT_ON_RAMP_CURRENCY_CZK' | 'FIAT_ON_RAMP_CURRENCY_DKK' | 'FIAT_ON_RAMP_CURRENCY_DOP' | 'FIAT_ON_RAMP_CURRENCY_EGP' | 'FIAT_ON_RAMP_CURRENCY_EUR' | 'FIAT_ON_RAMP_CURRENCY_GBP' | 'FIAT_ON_RAMP_CURRENCY_HKD' | 'FIAT_ON_RAMP_CURRENCY_IDR' | 'FIAT_ON_RAMP_CURRENCY_ILS' | 'FIAT_ON_RAMP_CURRENCY_JOD' | 'FIAT_ON_RAMP_CURRENCY_KES' | 'FIAT_ON_RAMP_CURRENCY_KWD' | 'FIAT_ON_RAMP_CURRENCY_LKR' | 'FIAT_ON_RAMP_CURRENCY_MXN' | 'FIAT_ON_RAMP_CURRENCY_NGN' | 'FIAT_ON_RAMP_CURRENCY_NOK' | 'FIAT_ON_RAMP_CURRENCY_NZD' | 'FIAT_ON_RAMP_CURRENCY_OMR' | 'FIAT_ON_RAMP_CURRENCY_PEN' | 'FIAT_ON_RAMP_CURRENCY_PLN' | 'FIAT_ON_RAMP_CURRENCY_RON' | 'FIAT_ON_RAMP_CURRENCY_SEK' | 'FIAT_ON_RAMP_CURRENCY_THB' | 'FIAT_ON_RAMP_CURRENCY_TRY' | 'FIAT_ON_RAMP_CURRENCY_TWD' | 'FIAT_ON_RAMP_CURRENCY_USD' | 'FIAT_ON_RAMP_CURRENCY_VND' | 'FIAT_ON_RAMP_CURRENCY_ZAR' - `fiatCurrencyAmount` string — Specifies a preset fiat amount for the transaction, e.g., '100'. Must be greater than '20'. If not provided, the user will be prompted to enter an amount. - `paymentMethod` 'FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD' | 'FIAT_ON_RAMP_PAYMENT_METHOD_APPLE_PAY' | 'FIAT_ON_RAMP_PAYMENT_METHOD_GBP_BANK_TRANSFER' | 'FIAT_ON_RAMP_PAYMENT_METHOD_GBP_OPEN_BANKING_PAYMENT' | 'FIAT_ON_RAMP_PAYMENT_METHOD_GOOGLE_PAY' | 'FIAT_ON_RAMP_PAYMENT_METHOD_SEPA_BANK_TRANSFER' | 'FIAT_ON_RAMP_PAYMENT_METHOD_PIX_INSTANT_PAYMENT' | 'FIAT_ON_RAMP_PAYMENT_METHOD_PAYPAL' | 'FIAT_ON_RAMP_PAYMENT_METHOD_VENMO' | 'FIAT_ON_RAMP_PAYMENT_METHOD_MOONPAY_BALANCE' | 'FIAT_ON_RAMP_PAYMENT_METHOD_CRYPTO_ACCOUNT' | 'FIAT_ON_RAMP_PAYMENT_METHOD_FIAT_WALLET' | 'FIAT_ON_RAMP_PAYMENT_METHOD_ACH_BANK_ACCOUNT' - `countryCode` string — ISO 3166-1 two-digit country code for Coinbase representing the purchasing user’s country of residence, e.g., US, GB. - `countrySubdivisionCode` string — ISO 3166-2 two-digit country subdivision code for Coinbase representing the purchasing user’s subdivision of residence within their country, e.g. NY. Required if country_code=US. - `sandboxMode` boolean — Optional flag to indicate whether to use the sandbox mode to simulate transactions for the on-ramp provider. Default is false. - `createSmartContractInterfaceIntent` V1CreateSmartContractInterfaceIntent - `smartContractAddress` string, required — Corresponding contract address or program ID - `smartContractInterface` string, required — ABI/IDL as a JSON string - `type` 'SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM' | 'SMART_CONTRACT_INTERFACE_TYPE_SOLANA', required - `label` string, required — Human-readable name for a Smart Contract Interface. - `notes` string — Notes for a Smart Contract Interface. - `deleteSmartContractInterfaceIntent` V1DeleteSmartContractInterfaceIntent - `smartContractInterfaceId` string, required — The ID of a Smart Contract Interface intended for deletion. - `enableAuthProxyIntent` V1EnableAuthProxyIntent - `disableAuthProxyIntent` V1DisableAuthProxyIntent - `updateAuthProxyConfigIntent` V1UpdateAuthProxyConfigIntent - `allowedOrigins` string[] — Updated list of allowed origins for CORS. - `allowedAuthMethods` string[] — Updated list of allowed proxy authentication methods. - `sendFromEmailAddress` string — Custom 'from' address for auth-related emails. - `replyToEmailAddress` string — Custom reply-to address for auth-related emails. - `emailAuthTemplateId` string — Template ID for email-auth messages. - `otpTemplateId` string — Template ID for OTP SMS messages. - `emailCustomizationParams` V1EmailCustomizationParams - `appName` string — The name of the application. - `logoUrl` string — A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px. - `magicLinkTemplate` string — 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`. - `templateVariables` string — JSON object containing key/value pairs to be used with custom templates. - `templateId` string — Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template. - `smsCustomizationParams` V1SmsCustomizationParams - `template` string — Template containing references to .OtpCode i.e Your OTP is {{.OtpCode}} - `walletKitSettings` V1WalletKitSettingsParams - `enabledSocialProviders` string[] — List of enabled social login providers (e.g., 'apple', 'google', 'facebook') - `otpExpirationSeconds` integer — OTP code lifetime in seconds. - `verificationTokenExpirationSeconds` integer — Verification-token lifetime in seconds. - `sessionExpirationSeconds` integer — Session lifetime in seconds. - `otpAlphanumeric` boolean — Enable alphanumeric OTP codes. - `otpLength` integer — Desired OTP code length (6–9). - `result` V1Result, required - `createOrganizationResult` V1CreateOrganizationResult - `organizationId` string, required — Unique identifier for a given Organization. - `createAuthenticatorsResult` V1CreateAuthenticatorsResult - `authenticatorIds` string[], required — A list of Authenticator IDs. - `createUsersResult` V1CreateUsersResult - `userIds` string[], required — A list of User IDs. - `createPrivateKeysResult` V1CreatePrivateKeysResult - `privateKeyIds` string[], required — A list of Private Key IDs. - `createInvitationsResult` V1CreateInvitationsResult - `invitationIds` string[], required — A list of Invitation IDs - `acceptInvitationResult` V1AcceptInvitationResult - `invitationId` string, required — Unique identifier for a given Invitation. - `userId` string, required — Unique identifier for a given User. - `signRawPayloadResult` V1SignRawPayloadResult - `r` string, required — Component of an ECSDA signature. - `s` string, required — Component of an ECSDA signature. - `v` string, required — Component of an ECSDA signature. - `createPolicyResult` V1CreatePolicyResult - `policyId` string, required — Unique identifier for a given Policy. - `disablePrivateKeyResult` V1DisablePrivateKeyResult - `privateKeyId` string, required — Unique identifier for a given Private Key. - `deleteUsersResult` V1DeleteUsersResult - `userIds` string[], required — A list of User IDs. - `deleteAuthenticatorsResult` V1DeleteAuthenticatorsResult - `authenticatorIds` string[], required — Unique identifier for a given Authenticator. - `deleteInvitationResult` V1DeleteInvitationResult - `invitationId` string, required — Unique identifier for a given Invitation. - `deleteOrganizationResult` V1DeleteOrganizationResult - `organizationId` string, required — Unique identifier for a given Organization. - `deletePolicyResult` V1DeletePolicyResult - `policyId` string, required — Unique identifier for a given Policy. - `createUserTagResult` V1CreateUserTagResult - `userTagId` string, required — Unique identifier for a given User Tag. - `userIds` string[], required — A list of User IDs. - `deleteUserTagsResult` V1DeleteUserTagsResult - `userTagIds` string[], required — A list of User Tag IDs. - `userIds` string[], required — A list of User IDs. - `signTransactionResult` V1SignTransactionResult - `signedTransaction` string, required - `deleteApiKeysResult` V1DeleteApiKeysResult - `apiKeyIds` string[], required — A list of API Key IDs. - `createApiKeysResult` V1CreateApiKeysResult - `apiKeyIds` string[], required — A list of API Key IDs. - `createPrivateKeyTagResult` V1CreatePrivateKeyTagResult - `privateKeyTagId` string, required — Unique identifier for a given Private Key Tag. - `privateKeyIds` string[], required — A list of Private Key IDs. - `deletePrivateKeyTagsResult` V1DeletePrivateKeyTagsResult - `privateKeyTagIds` string[], required — A list of Private Key Tag IDs. - `privateKeyIds` string[], required — A list of Private Key IDs. - `setPaymentMethodResult` BillingSetPaymentMethodResult - `lastFour` string, required — The last four digits of the credit card added. - `cardHolderName` string, required — The name associated with the payment method. - `cardHolderEmail` string, required — The email address associated with the payment method. - `activateBillingTierResult` BillingActivateBillingTierResult - `productId` string, required — The id of the product being subscribed to. - `deletePaymentMethodResult` BillingDeletePaymentMethodResult - `paymentMethodId` string, required — The payment method that was removed. - `createApiOnlyUsersResult` V1CreateApiOnlyUsersResult - `userIds` string[], required — A list of API-only User IDs. - `updateRootQuorumResult` V1UpdateRootQuorumResult - `updateUserTagResult` V1UpdateUserTagResult - `userTagId` string, required — Unique identifier for a given User Tag. - `updatePrivateKeyTagResult` V1UpdatePrivateKeyTagResult - `privateKeyTagId` string, required — Unique identifier for a given Private Key Tag. - `createSubOrganizationResult` V1CreateSubOrganizationResult - `subOrganizationId` string, required - `rootUserIds` string[] - `updateAllowedOriginsResult` V1UpdateAllowedOriginsResult - `createPrivateKeysResultV2` V1CreatePrivateKeysResultV2 - `privateKeys` V1PrivateKeyResult[], required — A list of Private Key IDs and addresses. - `privateKeyId` string - `addresses` Immutableactivityv1Address[] - `format` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP' - `address` string - `updateUserResult` V1UpdateUserResult - `userId` string, required — A User ID. - `updatePolicyResult` V1UpdatePolicyResult - `policyId` string, required — Unique identifier for a given Policy. - `createSubOrganizationResultV3` V1CreateSubOrganizationResultV3 - `subOrganizationId` string, required - `privateKeys` V1PrivateKeyResult[], required — A list of Private Key IDs and addresses. - `privateKeyId` string - `addresses` Immutableactivityv1Address[] - `format` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP' - `address` string - `rootUserIds` string[] - `createWalletResult` V1CreateWalletResult - `walletId` string, required — Unique identifier for a Wallet. - `addresses` string[], required — A list of account addresses. - `createWalletAccountsResult` V1CreateWalletAccountsResult - `addresses` string[], required — A list of derived addresses. - `initUserEmailRecoveryResult` V1InitUserEmailRecoveryResult - `userId` string, required — Unique identifier for the user being recovered. - `recoverUserResult` V1RecoverUserResult - `authenticatorId` string[], required — ID of the authenticator created. - `setOrganizationFeatureResult` V1SetOrganizationFeatureResult - `features` V1Feature[], required — Resulting list of organization features. - `name` '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' | 'FEATURE_NAME_AUTH_PROXY' - `value` string - `removeOrganizationFeatureResult` V1RemoveOrganizationFeatureResult - `features` V1Feature[], required — Resulting list of organization features. - `name` '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' | 'FEATURE_NAME_AUTH_PROXY' - `value` string - `exportPrivateKeyResult` V1ExportPrivateKeyResult - `privateKeyId` string, required — Unique identifier for a given Private Key. - `exportBundle` string, required — Export bundle containing a private key encrypted to the client's target public key. - `exportWalletResult` V1ExportWalletResult - `walletId` string, required — Unique identifier for a given Wallet. - `exportBundle` string, required — Export bundle containing a wallet mnemonic + optional newline passphrase encrypted by the client's target public key. - `createSubOrganizationResultV4` V1CreateSubOrganizationResultV4 - `subOrganizationId` string, required - `wallet` V1WalletResult - `walletId` string, required - `addresses` string[], required — A list of account addresses. - `rootUserIds` string[] - `emailAuthResult` V1EmailAuthResult - `userId` string, required — Unique identifier for the authenticating User. - `apiKeyId` string, required — Unique identifier for the created API key. - `exportWalletAccountResult` V1ExportWalletAccountResult - `address` string, required — Address to identify Wallet Account. - `exportBundle` string, required — Export bundle containing a private key encrypted by the client's target public key. - `initImportWalletResult` V1InitImportWalletResult - `importBundle` string, required — Import bundle containing a public key and signature to use for importing client data. - `importWalletResult` V1ImportWalletResult - `walletId` string, required — Unique identifier for a Wallet. - `addresses` string[], required — A list of account addresses. - `initImportPrivateKeyResult` V1InitImportPrivateKeyResult - `importBundle` string, required — Import bundle containing a public key and signature to use for importing client data. - `importPrivateKeyResult` V1ImportPrivateKeyResult - `privateKeyId` string, required — Unique identifier for a Private Key. - `addresses` Immutableactivityv1Address[], required — A list of addresses. - `format` 'ADDRESS_FORMAT_UNCOMPRESSED' | 'ADDRESS_FORMAT_COMPRESSED' | 'ADDRESS_FORMAT_ETHEREUM' | 'ADDRESS_FORMAT_SOLANA' | 'ADDRESS_FORMAT_COSMOS' | 'ADDRESS_FORMAT_TRON' | 'ADDRESS_FORMAT_SUI' | 'ADDRESS_FORMAT_APTOS' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH' | 'ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR' | 'ADDRESS_FORMAT_SEI' | 'ADDRESS_FORMAT_XLM' | 'ADDRESS_FORMAT_DOGE_MAINNET' | 'ADDRESS_FORMAT_DOGE_TESTNET' | 'ADDRESS_FORMAT_TON_V3R2' | 'ADDRESS_FORMAT_TON_V4R2' | 'ADDRESS_FORMAT_TON_V5R1' | 'ADDRESS_FORMAT_XRP' - `address` string - `createPoliciesResult` V1CreatePoliciesResult - `policyIds` string[], required — A list of unique identifiers for the created policies. - `signRawPayloadsResult` V1SignRawPayloadsResult - `signatures` V1SignRawPayloadResult[] - `r` string, required — Component of an ECSDA signature. - `s` string, required — Component of an ECSDA signature. - `v` string, required — Component of an ECSDA signature. - `createReadOnlySessionResult` V1CreateReadOnlySessionResult - `organizationId` string, required — 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. - `organizationName` string, required — Human-readable name for an Organization. - `userId` string, required — Unique identifier for a given User. - `username` string, required — Human-readable name for a User. - `session` string, required — String representing a read only session - `sessionExpiry` string, uint64, required — UTC timestamp in seconds representing the expiry time for the read only session. - `createOauthProvidersResult` V1CreateOauthProvidersResult - `providerIds` string[], required — A list of unique identifiers for Oauth Providers - `deleteOauthProvidersResult` V1DeleteOauthProvidersResult - `providerIds` string[], required — A list of unique identifiers for Oauth Providers - `createSubOrganizationResultV5` V1CreateSubOrganizationResultV5 - `subOrganizationId` string, required - `wallet` V1WalletResult - `walletId` string, required - `addresses` string[], required — A list of account addresses. - `rootUserIds` string[] - `oauthResult` V1OauthResult - `userId` string, required — Unique identifier for the authenticating User. - `apiKeyId` string, required — Unique identifier for the created API key. - `credentialBundle` string, required — HPKE encrypted credential bundle - `createReadWriteSessionResult` V1CreateReadWriteSessionResult - `organizationId` string, required — 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. - `organizationName` string, required — Human-readable name for an Organization. - `userId` string, required — Unique identifier for a given User. - `username` string, required — Human-readable name for a User. - `apiKeyId` string, required — Unique identifier for the created API key. - `credentialBundle` string, required — HPKE encrypted credential bundle - `createSubOrganizationResultV6` V1CreateSubOrganizationResultV6 - `subOrganizationId` string, required - `wallet` V1WalletResult - `walletId` string, required - `addresses` string[], required — A list of account addresses. - `rootUserIds` string[] - `deletePrivateKeysResult` V1DeletePrivateKeysResult - `privateKeyIds` string[], required — A list of private key unique identifiers that were removed - `deleteWalletsResult` V1DeleteWalletsResult - `walletIds` string[], required — A list of wallet unique identifiers that were removed - `createReadWriteSessionResultV2` V1CreateReadWriteSessionResultV2 - `organizationId` string, required — 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. - `organizationName` string, required — Human-readable name for an Organization. - `userId` string, required — Unique identifier for a given User. - `username` string, required — Human-readable name for a User. - `apiKeyId` string, required — Unique identifier for the created API key. - `credentialBundle` string, required — HPKE encrypted credential bundle - `deleteSubOrganizationResult` V1DeleteSubOrganizationResult - `subOrganizationUuid` string, required — Unique identifier of the sub organization that was removed - `initOtpAuthResult` V1InitOtpAuthResult - `otpId` string, required — Unique identifier for an OTP authentication - `otpAuthResult` V1OtpAuthResult - `userId` string, required — Unique identifier for the authenticating User. - `apiKeyId` string — Unique identifier for the created API key. - `credentialBundle` string — HPKE encrypted credential bundle - `createSubOrganizationResultV7` V1CreateSubOrganizationResultV7 - `subOrganizationId` string, required - `wallet` V1WalletResult - `walletId` string, required - `addresses` string[], required — A list of account addresses. - `rootUserIds` string[] - `updateWalletResult` V1UpdateWalletResult - `walletId` string, required — A Wallet ID. - `updatePolicyResultV2` V1UpdatePolicyResultV2 - `policyId` string, required — Unique identifier for a given Policy. - `initOtpAuthResultV2` V1InitOtpAuthResultV2 - `otpId` string, required — Unique identifier for an OTP authentication - `initOtpResult` V1InitOtpResult - `otpId` string, required — Unique identifier for an OTP authentication - `verifyOtpResult` V1VerifyOtpResult - `verificationToken` string, required — Signed JWT containing a unique id, expiry, verification type, contact. Verification status of a user is updated when the token is consumed (in OTP_LOGIN requests) - `otpLoginResult` V1OtpLoginResult - `session` string, required — Signed JWT containing an expiry, public key, session type, user id, and organization id - `stampLoginResult` V1StampLoginResult - `session` string, required — Signed JWT containing an expiry, public key, session type, user id, and organization id - `oauthLoginResult` V1OauthLoginResult - `session` string, required — Signed JWT containing an expiry, public key, session type, user id, and organization id - `updateUserNameResult` V1UpdateUserNameResult - `userId` string, required — Unique identifier of the User whose name was updated. - `updateUserEmailResult` V1UpdateUserEmailResult - `userId` string, required — Unique identifier of the User whose email was updated. - `updateUserPhoneNumberResult` V1UpdateUserPhoneNumberResult - `userId` string, required — Unique identifier of the User whose phone number was updated. - `initFiatOnRampResult` V1InitFiatOnRampResult - `onRampUrl` string, required — Unique URL for a given fiat on-ramp flow. - `onRampTransactionId` string, required — Unique identifier used to retrieve transaction statuses for a given fiat on-ramp flow. - `createSmartContractInterfaceResult` V1CreateSmartContractInterfaceResult - `smartContractInterfaceId` string, required — The ID of the created Smart Contract Interface. - `deleteSmartContractInterfaceResult` V1DeleteSmartContractInterfaceResult - `smartContractInterfaceId` string, required — The ID of the deleted Smart Contract Interface. - `enableAuthProxyResult` V1EnableAuthProxyResult - `userId` string, required — A User ID with permission to initiate authentication. - `disableAuthProxyResult` V1DisableAuthProxyResult - `updateAuthProxyConfigResult` V1UpdateAuthProxyConfigResult - `configId` string — Unique identifier for a given User. (representing the turnkey signer user id) - `votes` V1Vote[], required — A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. - `id` string, required — Unique identifier for a given Vote object. - `userId` string, required — Unique identifier for a given User. - `user` V1User, required - `userId` string, required — Unique identifier for a given User. - `userName` string, required — Human-readable name for a User. - `userEmail` string — The user's email address. - `userPhoneNumber` string — The user's phone number in E.164 format e.g. +13214567890 - `authenticators` V1Authenticator[], required — A list of Authenticator parameters. - `transports` V1AuthenticatorTransport[], required — Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE). - `attestationType` string, required - `aaguid` string, required — Identifier indicating the type of the Security Key. - `credentialId` string, required — Unique identifier for a WebAuthn credential. - `model` string, required — The type of Authenticator device. - `credential` Externaldatav1Credential, required - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `type` 'CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR' | 'CREDENTIAL_TYPE_API_KEY_P256' | 'CREDENTIAL_TYPE_RECOVER_USER_KEY_P256' | 'CREDENTIAL_TYPE_API_KEY_SECP256K1' | 'CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256' | 'CREDENTIAL_TYPE_API_KEY_ED25519' | 'CREDENTIAL_TYPE_OTP_AUTH_KEY_P256' | 'CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256' | 'CREDENTIAL_TYPE_OAUTH_KEY_P256' | 'CREDENTIAL_TYPE_LOGIN', required - `authenticatorId` string, required — Unique identifier for a given Authenticator. - `authenticatorName` string, required — Human-readable name for an Authenticator. - `createdAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `updatedAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `apiKeys` V1ApiKey[], required — A list of API Key parameters. This field, if not needed, should be an empty array in your request body. - `credential` Externaldatav1Credential, required - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `type` 'CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR' | 'CREDENTIAL_TYPE_API_KEY_P256' | 'CREDENTIAL_TYPE_RECOVER_USER_KEY_P256' | 'CREDENTIAL_TYPE_API_KEY_SECP256K1' | 'CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256' | 'CREDENTIAL_TYPE_API_KEY_ED25519' | 'CREDENTIAL_TYPE_OTP_AUTH_KEY_P256' | 'CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256' | 'CREDENTIAL_TYPE_OAUTH_KEY_P256' | 'CREDENTIAL_TYPE_LOGIN', required - `apiKeyId` string, required — Unique identifier for a given API Key. - `apiKeyName` string, required — Human-readable name for an API Key. - `createdAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `updatedAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `expirationSeconds` string, uint64 — Optional window (in seconds) indicating how long the API Key should last. - `userTags` string[], required — A list of User Tag IDs. - `oauthProviders` V1OauthProvider[], required — A list of Oauth Providers. - `providerId` string, required — Unique identifier for an OAuth Provider - `providerName` string, required — Human-readable name to identify a Provider. - `issuer` string, required — The issuer of the token, typically a URL indicating the authentication server, e.g https://accounts.google.com - `audience` string, required — Expected audience ('aud' attribute of the signed token) which represents the app ID - `subject` string, required — Expected subject ('sub' attribute of the signed token) which represents the user ID - `createdAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `updatedAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `createdAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `updatedAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `activityId` string, required — Unique identifier for a given Activity object. - `selection` 'VOTE_SELECTION_APPROVED' | 'VOTE_SELECTION_REJECTED', required - `message` string, required — The raw message being signed within a Vote. - `publicKey` string, required — The public component of a cryptographic key pair used to sign messages and transactions. - `signature` string, required — The signature applied to a particular vote. - `scheme` string, required — Method used to produce a signature. - `createdAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `fingerprint` string, required — An artifact verifying a User's action. - `canApprove` boolean, required - `canReject` boolean, required - `createdAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `updatedAt` Externaldatav1Timestamp, required - `seconds` string, required - `nanos` string, required - `failure` RpcStatus - `code` integer - `message` string - `details` ProtobufAny[] - `@type` string ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/turnkey/apis/api-reference.md) · [All operations](https://skmtc.net/turnkey/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/turnkey/api-reference/versions/4d8a7c63c511/schema)