class Stytch::CryptoWallets
def authenticate_start(
The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
status_code::
The type of this field is +Boolean+.
In `login_or_create` endpoints, this field indicates whether or not a User was just created.
user_created::
The type of this field is +String+.
A challenge string to be signed by the wallet in order to prove ownership.
challenge::
The type of this field is +String+.
The unique ID of the affected User.
user_id::
The type of this field is +String+.
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
request_id::
An object with the following fields:
== Returns:
The type of this field is nilable +SIWEParams+ (+object+).
The parameters for a Sign In With Ethereum (SIWE) message. May only be passed if the `crypto_wallet_type` is `ethereum`.
siwe_params::
The type of this field is nilable +String+.
The `session_jwt` associated with a User's existing Session.
session_jwt::
The type of this field is nilable +String+.
The `session_token` associated with a User's existing Session.
session_token::
The type of this field is nilable +String+.
The unique ID of a specific User. You may use an external_id here if one is set for the user.
user_id::
The type of this field is +String+.
The crypto wallet address to authenticate.
crypto_wallet_address::
The type of this field is +String+.
The type of wallet to authenticate. Currently `ethereum` and `solana` are supported. Wallets for any EVM-compatible chains (such as Polygon or BSC) are also supported and are grouped under the `ethereum` type.
crypto_wallet_type::
== Parameters:
If not using the SIWE protocol, the message will simply consist of the project name and a random string.
If the crypto wallet detects that the domain in the message does not match the website's domain, it will display a warning to the user.
For Ethereum crypto wallets, you can optionally use the Sign In With Ethereum (SIWE) protocol for the message by passing in the `siwe_params`. The only required fields are `domain` and `uri`.
Initiate the authentication of a crypto wallet. After calling this endpoint, the user will need to sign a message containing the returned `challenge` field.
def authenticate_start( crypto_wallet_type:, crypto_wallet_address:, user_id: nil, session_token: nil, session_jwt: nil, siwe_params: nil ) headers = {} request = { crypto_wallet_type: crypto_wallet_type, crypto_wallet_address: crypto_wallet_address } request[:user_id] = user_id unless user_id.nil? request[:session_token] = session_token unless session_token.nil? request[:session_jwt] = session_jwt unless session_jwt.nil? request[:siwe_params] = siwe_params unless siwe_params.nil? post_request('/v1/crypto_wallets/authenticate/start', request, headers) end