Stytch · Schema

api_crypto_wallet_v1_SIWEParams

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
domain	string	Only required if `siwe_params` is passed. The domain that is requesting the crypto wallet signature. Must be an RFC 3986 authority.
uri	string	Only required if `siwe_params` is passed. An RFC 3986 URI referring to the resource that is the subject of the signing.
resources	array	A list of information or references to information the user wishes to have resolved as part of authentication. Every resource must be an RFC 3986 URI.
chain_id	string	The EIP-155 Chain ID to which the session is bound. Defaults to 1. Must be the string representation of an integer between 1 and 9,223,372,036,854,775,771, inclusive.
statement	string	A human-readable ASCII assertion that the user will sign. The statement may only include reserved, unreserved, or space characters according to RFC 3986 definitions, and must not contain other forms o
issued_at	string	The time when the message was generated. Defaults to the current time. All timestamps in our API conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
not_before	string	The time when the signed authentication message will become valid. Defaults to the current time. All timestamps in our API conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T1
message_request_id	string	A system-specific identifier that may be used to uniquely refer to the sign-in request. The `message_request_id` must be a valid pchar according to RFC 3986 definitions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_crypto_wallet_v1_SIWEParams",
  "title": "api_crypto_wallet_v1_SIWEParams",
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Only required if `siwe_params` is passed. The domain that is requesting the crypto wallet signature. Must be an RFC 3986 authority."
    },
    "uri": {
      "type": "string",
      "description": "Only required if `siwe_params` is passed. An RFC 3986 URI referring to the resource that is the subject of the signing."
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": " A list of information or references to information the user wishes to have resolved as part of authentication. Every resource must be an RFC 3986 URI."
    },
    "chain_id": {
      "type": "string",
      "description": "The EIP-155 Chain ID to which the session is bound. Defaults to 1. Must be the string representation of an integer between 1 and 9,223,372,036,854,775,771, inclusive."
    },
    "statement": {
      "type": "string",
      "description": "A human-readable ASCII assertion that the user will sign. The statement may only include reserved, unreserved, or space characters according to RFC 3986 definitions, and must not contain other forms of whitespace such as newlines, tabs, and carriage returns."
    },
    "issued_at": {
      "type": "string",
      "description": "The time when the message was generated. Defaults to the current time. All timestamps in our API conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`."
    },
    "not_before": {
      "type": "string",
      "description": "The time when the signed authentication message will become valid. Defaults to the current time. All timestamps in our API conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`."
    },
    "message_request_id": {
      "type": "string",
      "description": "A system-specific identifier that may be used to uniquely refer to the sign-in request. The `message_request_id` must be a valid pchar according to RFC 3986 definitions."
    }
  },
  "required": [
    "domain",
    "uri",
    "resources"
  ]
}