Skip to main content
This quickstart walks you through every step needed to go from a new account to a successful API response from Nyota Imara. By the end you will have a working JWT and will have fetched your own user profile from https://api.nyotaimara.com/v1.

​
Base URL

All Nyota Imara API endpoints are served from: 
https://api.nyotaimara.com/v1
Every path in this documentation is relative to this base URL.

​
Steps

1

Create your account

Go to accounts.nyotaimara.com and sign up with your email address. Verify your email when the confirmation message arrives.
Use the email address you want associated with your Nyota Imara profile. You can update your display name and phone number from your account settings after sign-in.
2

Sign in and retrieve your JWT

Sign in at accounts.nyotaimara.com. After a successful login, Nyota Imara issues you a JWT (JSON Web Token). Copy this token — you will include it in the Authorization header of every API request.The token format looks like this:
eyJhbGciOiJFUzI1NiIsImtpZCI6Ii...
If you are building an application, retrieve the JWT from your sign-in flow and store it securely. Pass it in the Authorization header on every API request.
3

Make your first API call

Use the JWT to call GET /v1/users/me. This endpoint returns your own user profile and confirms that authentication is working correctly.Replace <your-jwt-token> with the token from the previous step:
curl --request GET \
  --url https://api.nyotaimara.com/v1/users/me \
  --header "Authorization: Bearer <your-jwt-token>"
4

Verify the response

A successful request returns HTTP 200 with your user profile:
{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "email": "you@example.com",
    "firstName": "Amina",
    "lastName": "Wanjiku",
    "phone": "+254712345678",
    "dob": null,
    "avatarUrl": null,
    "status": "active",
    "kycStatus": "unverified",
    "createdAt": "2026-01-15T08:30:00.000Z",
    "updatedAt": "2026-01-15T08:30:00.000Z"
  }
}
If you see "success": true and your email address in the response, your authentication is working and you are ready to explore the rest of the API.
kycStatus starts as "unverified". Complete identity verification to unlock features that require a verified identity. See Identity Verification for details.
5

Create an organization

Most Nyota Imara features — billing, commerce, logistics, team management — operate within an organization context. Create your first organization so you can start using these features.Follow the Creating an Organization guide to set one up. Once created, pass the organization’s UUID in the X-Organization-Id header on all org-scoped requests.

​
Next steps

Authentication

Understand how Bearer token authentication works and how to handle token errors.

Organizations

Learn how organizations, members, and roles structure access to platform features.

Identity verification

Submit KYC documents to verify your identity and unlock the full platform.

API Reference

Browse the full REST API reference with request and response schemas.