> ## Documentation Index
> Fetch the complete documentation index at: https://docs.turnkey.com/llms.txt
> Use this file to discover all available pages before exploring further.

# signMessage()

export const NestedParam = ({parentKey, childKey, type, required, description, children}) => {
  const fullKey = `${parentKey}.${childKey}`;
  const anchorId = `body-${fullKey.replace(/\./g, '-')}`;
  return <div className="py-6 border-gray-100 dark:border-gray-800 border-b last:border-b-0">
  <div className="flex font-mono text-sm group/param-head param-head break-all relative" id={anchorId}>
    <div className="flex-1 flex content-start py-0.5 mr-5">
      <div className="flex items-center flex-wrap gap-2">
        <div className="absolute -top-1.5">
          <a href={`#${anchorId}`} className="-ml-[2.1rem] flex items-center opacity-0 border-0 group-hover/param-head:opacity-100 py-2 [.expandable-content_&]:-ml-[2.1rem]" aria-label="Navigate to header">
            <div className="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20">
              <svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512">
                <path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path>
              </svg>
            </div>
          </a>
        </div>
        <div className="font-semibold text-primary dark:text-primary-light cursor-pointer overflow-wrap-anywhere">
          <span className="text-gray-500 dark:text-gray-400">{parentKey}.</span>
          {childKey}
        </div>
        <div className="inline items-center gap-2 text-xs font-medium [&_div]:inline [&_div]:mr-2 [&_div]:leading-5">
          <div className="flex items-center px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-gray-600 dark:text-gray-200 font-medium break-all">
            <span>{type}</span>
          </div>
          {required && <span className="px-2 py-0.5 rounded-md bg-red-100/50 dark:bg-red-400/10 text-red-600 dark:text-red-300 font-medium whitespace-nowrap">
              required
            </span>}
        </div>
      </div>
    </div>
  </div>
  {children && <div className="mt-4">
      <div className="prose prose-sm prose-gray dark:prose-invert">
        {children}
      </div>
    </div>}
</div>;
};

export const H3Bordered = ({text}) => <h3 id={text.toLowerCase()} className="border-b pb-2.5 border-gray-100 dark:border-gray-800">
    {text}
  </h3>;

<p><strong>Package:</strong> <code>react-native-wallet-kit</code></p>

<H3Bordered text="Overview" />

Signs a message using the specified wallet account.

Behavior differs depending on the wallet type:

<ul>
  <li>**Connected wallets**</li>
  <li>Delegates signing to the wallet provider’s native signing method.</li>
  <li>*Ethereum*: signatures always follow [EIP-191](https://eips.ethereum.org/EIPS/eip-191).</li>
  <li>The wallet automatically prefixes messages with</li>
</ul>

`"\x19Ethereum Signed Message:\n" + message length` before signing.

<ul>
  <li>As a result, these signatures cannot be used as raw transaction signatures or broadcast on-chain.</li>
  <li>If `addEthereumPrefix` is set to `false`, an error is thrown because connected Ethereum wallets always prefix.</li>
  <li>*Other chains*: follows the native connected wallet behavior.</li>
</ul>

<ul>
  <li>**Embedded wallets**</li>
  <li>Uses the Turnkey API to sign the message directly.</li>
  <li>Supports optional `addEthereumPrefix`:</li>
  <li>If `true` (default for Ethereum), the message is prefixed before signing.</li>
  <li>If `false`, the raw message is signed without any prefix.</li>
</ul>

Additional details:

<ul>
  <li>Automatically handles encoding and hashing based on the wallet account’s address format,</li>
</ul>

unless explicitly overridden.

<ul>
  <li>Optionally allows stamping with a specific stamper</li>
</ul>

(`StamperType.Passkey`, `StamperType.ApiKey`, or `StamperType.Wallet`).

<H3Bordered text="Parameters" />

<ParamField body="params" type="SignMessageParams" required={true}>
  <Expandable title="params details">
    <NestedParam parentKey="params" childKey="addEthereumPrefix" type="boolean" required={false}>
      whether to prefix the message with Ethereum’s
      `"\x19Ethereum Signed Message:\n"` string (default: `true` for Ethereum).
    </NestedParam>

    <NestedParam parentKey="params" childKey="encoding" type="v1PayloadEncoding" required={false}>
      override for payload encoding (defaults to the encoding appropriate for the address format).
    </NestedParam>

    <NestedParam parentKey="params" childKey="hashFunction" type="v1HashFunction" required={false}>
      override for hash function (defaults to the function appropriate for the address format).
    </NestedParam>

    <NestedParam parentKey="params" childKey="message" type="string" required={true}>
      plaintext (UTF-8) message to sign.
    </NestedParam>

    <NestedParam parentKey="params" childKey="organizationId" type="string" required={false}>
      organization ID to target (defaults to the session's organization ID).
    </NestedParam>

    <NestedParam parentKey="params" childKey="stampWith" type="StamperType" required={false}>
      optional stamper for the signing request.
    </NestedParam>

    <NestedParam parentKey="params" childKey="walletAccount" type="WalletAccount" required={true}>
      wallet account to use for signing.
    </NestedParam>
  </Expandable>
</ParamField>

<H3Bordered text="Response" />

A successful response returns the following fields:

<ResponseField name="returns" type="v1SignRawPayloadResult" required={true}>
  A promise that resolves to a `v1SignRawPayloadResult` containing the signature and metadata.
</ResponseField>