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

# Verify SIWE signature JSON Schema

> Verify SIWE signature JSON Schema contract. Includes route metadata, request parameters, response statuses, examples, and JSON fields for implementation.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

Verify a signed SIWE message for an existing active wallet account, consume the single-use nonce, and set auth cookies for browser/session flows. Unknown wallets receive HTTP 403 with `wallet_account_required`; verification never creates a Free account. Standard Free signup is available at [https://0xarchive.io/signup](https://0xarchive.io/signup) and paid wallet access at `/v1/web3/subscribe`.

## Route Metadata

| Field | Value |
| - | - |
| Method | `POST` |
| Path | `/v1/auth/web3/verify` |
| operationId | `web3Verify` |
| Tag | Web3 Authentication |
| Family | Web3 Auth |
| Deprecated or legacy | no |

## Human endpoint reference

Open [`POST /v1/auth/web3/verify`](/api-reference/web3-authentication/verify-siwe-signature) for authentication, parameters, responses, and examples.

## Request Body

### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "web3Verify request body",
  "type": "object",
  "required": [
    "message",
    "signature"
  ],
  "properties": {
    "message": {
      "description": "SIWE message returned by `/v1/auth/web3/challenge` and signed by the wallet.",
      "type": "string"
    },
    "signature": {
      "description": "65-byte hex ECDSA signature, with or without 0x prefix.",
      "type": "string",
      "example": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
    }
  }
}
```

## Response Contracts

### Status 200

SIWE verification succeeded and session cookies were set.

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "web3Verify response 200",
  "description": "Successful SIWE verification response for an existing wallet account. The route also sets auth cookies for browser/session flows.",
  "type": "object",
  "required": [
    "is_new_user",
    "success",
    "user"
  ],
  "properties": {
    "is_new_user": {
      "description": "Always false. SIWE verification does not create wallet accounts.",
      "type": "boolean",
      "enum": [
        false
      ],
      "example": false
    },
    "success": {
      "type": "boolean",
      "example": true
    },
    "user": {
      "type": "object",
      "required": [
        "email",
        "id",
        "tier",
        "wallet_address"
      ],
      "properties": {
        "email": {
          "description": "Account email associated with the wallet user.",
          "type": "string"
        },
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "tier": {
          "description": "Current subscription tier.",
          "type": "string",
          "example": "free"
        },
        "wallet_address": {
          "description": "Authenticated wallet address.",
          "type": "string",
          "example": "0x742d35cc6634c0532925a3b844bc9e7595f2bd18"
        }
      }
    }
  }
}
```

### Status 400

Invalid request

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "web3Verify response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "param": "limit",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
  "success": false
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "web3Verify response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}
```

### Status 403

The wallet does not have an existing account.

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "web3Verify response 403",
  "type": "object",
  "required": [
    "code",
    "error",
    "error_code",
    "request_id"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32"
    },
    "error": {
      "type": "string"
    },
    "error_code": {
      "type": "string"
    },
    "request_id": {
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 403,
  "error": "This wallet does not have an existing account. Use standard signup for Free access or purchase paid wallet access.",
  "error_code": "wallet_account_required",
  "request_id": "00000000-0000-0000-0000-000000000000"
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "web3Verify response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.