Log an end-user in with email + password. Returns a session token, or an MFA challenge if 2FA is enabled.

POSThttps://staging.softsolz.uk/api/v1/services/customer-auth/sessions

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Body Params

emailstring

End-user email.

passwordstring

End-user plaintext password.

Response

Response Body

userobjectEnd-user identity (non-MFA path).

sessionobjectThe issued session token and its metadata.

mfa_requiredbooleanPresent and true when an MFA challenge is required.

challenge_tokenstring | nullShort-lived (5 min) MFA challenge token (MFA path only).

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.customerAuth.createSession({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "user": {},
    "session": {},
    "mfa_required": true,
    "challenge_token": "string"
  }
}