Skip to main content
This is the first call you make in any Interstellas integration. The accessToken returned here is required on every subsequent request.

Endpoint

POST /auth/signin
No authentication headers are required for this endpoint.

Request body

email
string
required
The email address associated with your Interstellas account.
password
string
required
Your account password.

Response

status
boolean
true on success.
message
string
Human-readable outcome, e.g. "Login successful".
data.id
string
Your user ID.
data.firstName
string
Your first name.
data.lastName
string
Your last name.
data.email
string
Your registered email address.
data.phoneNo
string
Your registered phone number.
data.accessToken
string
A JWT bearer token. Pass this as Authorization: Bearer <token> on all subsequent requests.
data.businesses
array
List of businesses registered to your account. Each object contains id, businessName, and isApproved. Use the id value as your businessId header.

Code examples

curl -X POST https://sandbox.stellasbank.com/api/v1/auth/signin \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "YOUR_PASSWORD"
  }'

Example response

{
  "status": true,
  "message": "Login successful",
  "data": {
    "id": "usr_abc123",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "email": "you@example.com",
    "phoneNo": "+2348012345678",
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "businesses": [
      {
        "id": "biz_xyz789",
        "businessName": "Acme Ltd",
        "isApproved": true
      }
    ]
  }
}
Store your accessToken and SECRET_KEY securely — never log or expose them. If you have multiple businesses, make sure you use the correct businessId for each request.