Rider app

Invite riders to N-Ways Business, the companies' phone app (background position sharing, jobs, proof of delivery).

On this page

The rider's invitations to N-Ways Business (never their codes), newest first
Invite the rider to N-Ways Business
Withdraw an invitation (its code stops working)
Take the rider's N-Ways account off this driver

Note:

Send your key as key=YOUR_API_KEY on the address, or in the X-NWays-Api-Key header. API keys

Base address: https://nways.ng/maps/v1/fleet

The rider's invitations to N-Ways Business (never their codes), newest first

GET https://nways.ng/maps/v1/fleet/drivers/{id}/invites

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/drivers/string/invites', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/fleet/drivers/string/invites",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Invitations

Field	Type	Description
`invites`	`RiderInvite[]`	Required.
`invites[].id`	`string`	Required.
`invites[].driverId`	`string`	Required.
`invites[].code`	`string`	Only when made.
`invites[].url`	`string (uri)`	Only when made: https://nways.ng/r/<code>.
`invites[].createdBy`	`string`	Required.
`invites[].createdAt`	`string (date-time)`	Required.
`invites[].expiresAt`	`string (date-time)`	Required.
`invites[].usedAt`	`string (date-time) \| null`	Required.
`invites[].revokedAt`	`string (date-time) \| null`	Required.
`invites[].active`	`boolean`	Required.

200 OK

{
  "invites": [
    {
      "id": "string",
      "driverId": "string",
      "code": "string",
      "url": "string",
      "createdBy": "string",
      "createdAt": "2026-10-15T09:00:00+01:00",
      "expiresAt": "2026-10-15T09:00:00+01:00",
      "usedAt": "2026-10-15T09:00:00+01:00",
      "revokedAt": "2026-10-15T09:00:00+01:00",
      "active": true
    }
  ]
}

Errors

default Error

Invite the rider to N-Ways Business

POST https://nways.ng/maps/v1/fleet/drivers/{id}/invites

The answer's code (8 characters, shown as XXXX-XXXX) and url (https://nways.ng/r/…) are shown once: send them to the rider. On a phone with N-Ways Business the link opens the app; otherwise the rider installs it, signs in with their N-Ways account and types the code. Joining binds the rider's account to this driver: the app then shares the phone's position in the background while the rider is on duty (for the vehicle whose driverId is this driver), shows that vehicle's tasks and marks them picked up, delivered or failed with photo or signature proof. A new invitation replaces the rider's earlier ones; each works once.

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

Request body

Field	Type	Description
`days`	`integer`	How long the code works. Default: `7`. ≥ 1, ≤ 30.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
  -H "X-NWays-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":7}'

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/drivers/string/invites', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "days": 7
  }),
})
const data = await res.json()

Python

import os
import requests

res = requests.post(
    "https://nways.ng/maps/v1/fleet/drivers/string/invites",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"days": 7},
    timeout=10,
)
data = res.json()

Response

The invitation with its code and url

Field	Type	Description
`id`	`string`	Required.
`driverId`	`string`	Required.
`code`	`string`	Only when made.
`url`	`string (uri)`	Only when made: https://nways.ng/r/<code>.
`createdBy`	`string`	Required.
`createdAt`	`string (date-time)`	Required.
`expiresAt`	`string (date-time)`	Required.
`usedAt`	`string (date-time) \| null`	Required.
`revokedAt`	`string (date-time) \| null`	Required.
`active`	`boolean`	Required.

201 OK

{
  "id": "string",
  "driverId": "string",
  "code": "string",
  "url": "string",
  "createdBy": "string",
  "createdAt": "2026-10-15T09:00:00+01:00",
  "expiresAt": "2026-10-15T09:00:00+01:00",
  "usedAt": "2026-10-15T09:00:00+01:00",
  "revokedAt": "2026-10-15T09:00:00+01:00",
  "active": true
}

Errors

default Error

Withdraw an invitation (its code stops working)

DELETE https://nways.ng/maps/v1/fleet/invites/{inviteId}

Parameters

Name	In	Type	Description
`inviteId`	path	`string`	Required.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/invites/string" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/invites/string', {
  method: 'DELETE',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.delete(
    "https://nways.ng/maps/v1/fleet/invites/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Withdrawn

No content.

Errors

default Error

Take the rider's N-Ways account off this driver

DELETE https://nways.ng/maps/v1/fleet/drivers/{id}/app

The app stops sharing the rider's position and showing their jobs at once. Invite them again to bring them back.

Parameters

Name	In	Type	Description
`id`	path	`string`	Required.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/drivers/string/app" \
  -H "X-NWays-Api-Key: YOUR_API_KEY"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/drivers/string/app', {
  method: 'DELETE',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()

Python

import os
import requests

res = requests.delete(
    "https://nways.ng/maps/v1/fleet/drivers/string/app",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Response

Unlinked

No content.

Errors

default Error