🚘Drivers

This object represents all drivers registered on the system.

Fetching drivers without query params will return all drivers including approved and not approved.

Fetch all drivers registered

GET https://api.data.tapngogh.com/drivers/all

Returns an object containing all drivers

Query Parameters

Name	Type	Description
limit	Number	Total number of documents to fetch: Default 50
approved	Boolean	Fetch drivers based on approval status
email	String	Fetch a driver by email

200: OK

{
	"status": 1,
	"payload": [
		{
			"approvalChecklist": {
				"validLicense": true,
				"hasSmartPhone": true,
				"canUseMap": true,
				"criminalRecord": true
			},
			"_id": "632ae6d9deeb82b5eb2f5b3c",
			"name": "Mushud",
			"phone": "0548215801",
			"email": "[email protected]",
			"license": "1234566",
			"licenseClass": "A",
			"licenseExpiry": "2022-09-30T00:00:00.000Z",
			"licenseIssueDate": "2022-09-14T00:00:00.000Z",
			"idType": "national-id",
			"online": true,
			"busy": false,
			"idNumber": "123456789",
			"gender": "male",
			"verified": true,
			"approved": true,
			"createdAt": "2022-09-21T10:26:33.031Z",
			"updatedAt": "2022-09-30T10:12:43.928Z",
			"__v": 0,
			"activationKey": "3759068851",
			"ownerID": {
				"_id": "632ae602deeb82b5eb2f5b29",
				"name": "MUSHUD",
				"phone": "0548215801",
				"email": "[email protected]",
				"idType": "national-id",
				"idNumber": "1234567890",
				"verified": false,
				"createdAt": "2022-09-21T10:22:58.942Z",
				"updatedAt": "2022-09-21T10:22:58.942Z",
				"__v": 0
			},
			"dateActivated": "2022-09-30T09:10:26.920Z",
			"hyperAccount": "0548215801",
			"rating": 5
		}
	]
}

401: Unauthorized

Add Driver

This helps you to register drivers. Drivers registered will need to be approved at the assembly Dashboard.

Driver Schema

To add a driver you'll need to make reference to the schema below to create your payload body obbject

// Driver schema payload 

{
    title: { type: String },
    name: { type: String, required: true, unique: true },
    yearsOfDriving: { type: Number },
    region: { type: String },
    city: { type: String },
    maritalStatus: { type: String },
    phone: { type: String, required: true, unique: true },
    email: { type: String },
    dob: { type: Date, required: true },
    driverType: { type: String, enum: ["taxi", "trotro", "private"] },
    profileUrl: { type: String },
    firstName: { type: String },
    currentAddress: { type: String },
    maritalStatus: { type: String },
    lastName: { type: String },
    otherNames: { type: String },
    license: { type: String, required: true },
    licenseClass: { type: String, required: true, enum: ["A", "B", "C", "D"] },
    licenseExpiry: { type: Date, required: true },
    licenseIssueDate: { type: Date, required: true },
    idType: {
      type: String,
      enum: ["national-id", "passport", "voters-id"],
      required: true,
    },
    online: { type: Boolean, default: false },
    driverStatusDate: { type: Date },
    profileUrl: {
      type: String,
      default:
        "https://thumbs.dreamstime.com/b/default-avatar-photo-placeholder-profile-picture-default-avatar-photo-placeholder-profile-picture-eps-file-easy-to-edit-125707135.jpg",
    },
    idNumber: { type: String, required: true },
    gender: { type: String, enum: ["male", "female"] },
    password: { type: String },
    memberID: { type: String },
    approvalChecklist: {
      validLicense: { type: Boolean },
      hasSmartPhone: { type: Boolean },
      canUseMap: { type: Boolean },
      criminalRecord: { type: Boolean },
    },
}

POST https://api.data.tapngogh.com/drivers/add