Skip to main content

Initiate Login

POST 
/auth/login-init

Initiate the login sequence for an existing user. Multiple authentication methods are supported. To initiate login for a new user, use Sign Up. Alternatively, if you'd like to use login-init for both new and existing users, use the autoSignup request body option. To complete the login flow, use Complete Login. For more details, see Authentication.

Request​

Body

required

    oneOf

    loginMethod stringrequired

    Possible values: [algorand]

    The login method to use.

    network stringrequired

    Possible values: [algorand-mainnet, algorand-testnet]

    The blockchain network associated with the web3 address.

    clientApplicationId stringrequired

    ID of the client application created in an Immersve partner profile.

    scopes string[]required

    Possible values: [cardholder-partner]

    An array of authorization scopes requested by the client application.

    address stringrequired

    The web3 address to which the challenge is directed.

    autoSignup boolean

    Possible values: [true, false]

    If set to true, creates a user account if one does not already exist for the web3 address attempting to log in.

Responses​

Successful operation

Schema

    id string

    The unique identifier of the login request.

    loginMethod string

    The login method used.

    mode string

    Possible values: [cardholder-login]

    Identifies intention of the user.

    network string

    The blockchain network associated with the web3 address.

    clientApplicationId string

    ID of the client application created in an Immersve partner profile.

    scopes string[]

    Possible values: [cardholder-partner]

    An array of authorization scopes requested by the client application.

    createdAt string

    The date and time the login request was created.

    url url

    Domain in the "<domain> wants you to sign in.." of the EIP-4361 is derived from the host fragment of this parameter. The client application identified by clientApplicationId must allow this URL.

    address string

    The web3 address to which the challenge is directed.

    signingChallenge

    object

    description string

    The description of the challenge.

    createdAt string

    The date and time the challenge was created.

    expiresAt string

    The date and time the challenge expires.

    message

    The message to be signed by the web3 address owner.

Loading...