DEVELOPER PLATFORM · API v1

Your integration.
Precisely controlled access.

Connect your application to approved company data. Apply through onboarding, or receive access created directly by the Super Administrator. The Super Administrator decides the company, resources, request limit and access duration.

Apply for API access →Read the integration guide
Company isolationTime-limited keysImmediate revocation
01 / Apply

Tell us what you need

Submit your organization, development purpose, requested data and duration.

02 / Approval

Access is reviewed

The Super Admin verifies your request and grants the minimum required access. Approval is manual.

03 / Build

Receive your secret securely

Your approved contact receives a one-time key from the Super Admin. Use it from your server.

CLEAR COMMERCIAL TERMS

Developer API pricing

Every approved integration begins with a secure onboarding and setup. Your Super Admin confirms the plan and licensed API users before access is issued.

One-time registration & secure setup₹5,000Applies once per developer API integration. Includes onboarding review, company boundary setup and key issuance.
MONTHLY

Flexible monthly billing

₹100 / user / month

For the first 5 licensed API users.

  • 5 users: ₹500/month
  • User 6 onward: ₹125/user/month
  • ₹5,000 setup charged once

“Users” means named people authorized to manage or use the integration. API scopes, company data boundary and expiry remain controlled by the Super Administrator.

GET CONNECTED

Make your first request

Base URL: https://ndclients.co.in/api/v1/developer

1. Submit the onboarding form below and keep your application reference, or ask your Super Admin to create access directly.
2. Wait for manual review. Your application reference is not an API key.
3. Receive the approved key securely from the Super Admin.
4. Store it as a server environment variable named NDFA_API_KEY.

curl --fail-with-body \
  -H "Authorization: Bearer $NDFA_API_KEY" \
  "https://ndclients.co.in/api/v1/developer/data/customers?page=1&limit=50"

Node.js 20+ server example:

const response = await fetch(
  'https://ndclients.co.in/api/v1/developer/data/customers?limit=50',
  { headers: { Authorization: `Bearer ${process.env.NDFA_API_KEY}` } }
);
const result = await response.json();
if (!response.ok) throw new Error(result.message);
console.log(result.data.items);

Keep the key on your backend. Do not place it in browser JavaScript, mobile binaries, public repositories or URLs. Website staff passwords and login tokens are separate from developer API access.

Available resources

All integration endpoints are GET /data/{resource}. Access is read-only and limited to exactly one approved company. Fields absent in the source record are omitted.

Resource / scopeReturned fields
customers
customers:read
id, name, mobile, branch, status, createdAt
listings
listings:read
id, name, mobile, branch, status, createdAt
attendance
attendance:read
id, userId, date, checkInTime, checkOutTime, status
employees
employees:read
id, name, employeeId, role, branch, isActive
locations
locations:read
id, name, code, isActive

Passwords, biometric registration photos/templates, identity documents, recordings and payroll are excluded. Tracking routes and write operations are not available through this developer API.

Pagination

page: positive integer, default 1. limit: 1–100, default 50. Read data.total and advance the page until all records are received. Records can change between requests; pagination is not a snapshot.

The public machine-readable field catalog is GET /catalog.

Responses and errors

{
  "success": true,
  "message": "Company data",
  "data": {
    "items": [{ "id": "C_EXAMPLE", "name": "Example customer" }],
    "page": 1, "limit": 50, "total": 1
  }
}
HTTPMeaning / next step
200Successful data response; items can be empty.
201Onboarding application accepted. Save data.id.
400Invalid input. Correct fields or pagination.
401Key missing, invalid, expired or revoked. Contact the Super Admin.
403Scope unavailable, company suspended or company module disabled.
404Endpoint does not exist.
429Limit exceeded. Wait the Retry-After header duration before retrying.
500Server failure. Retry with bounded exponential backoff.

Error envelope: {"success":false,"message":"…","data":null}. Do not repeatedly retry 400, 401 or 403 responses.

Who controls access?

Only the Super Administrator can approve/reject requests, choose company and read scopes, set 1–365 days of access and a limit of 1–600 requests per minute, rotate keys or revoke access.

Expiry starts when approval occurs and is checked on every request. Company suspension or disabling the relevant company module or its export permission also blocks access immediately. Rotating a key invalidates the previous secret without extending the expiry. To renew or change scopes/company/limits, submit a new onboarding request; the Super Admin can revoke the old grant.

Limits use an in-memory window per API process. Production should run one API process for a consistent limit; a process restart resets the window. Request totals count successful reads and are persisted periodically. Management actions are recorded in platform activity.

There is no automatic email delivery, public approval-status lookup or sandbox provisioning. The Super Admin reviews your contact details and shares the secret through a secure channel. Use an approved test company to build and test before requesting production data.

START HERE

Request developer access

Choose the expected licensed-user plan so the Super Administrator can review the commercial terms together with access scope. The ₹5,000 setup fee is charged only once per approved integration.

Requested resources

Submit onboarding from your backend instead

POST /api/v1/developer/applications with Content-Type application/json. Limit: 5 submissions per hour per server-observed IP. The form uses this exact contract:

{ "name": "Developer name", "email": "dev@example.com",
  "organization": "Example company", "purpose": "Internal reporting",
  "scopes": ["customers:read"], "requestedDays": 30,
  "billing": { "plan": "monthly", "users": 5 }, "consent": true }

Response: {"success":true,"message":"…","data":{"id":"APP_…","status":"pending"}}