Mobility Docs

Organization

Organization to managed and run the mobility service.

Creating an Organization

Organization should be created a an Admin. After the organization is created, the Admin can create and assign a new Owner of the Organization.

Members

There can be multiple members in an organization to help manage verify documents, assign rider to order, contact drivers and customers.

Members are to be added by the Admin

Configurations

Configuration available to the organization :

Global Config

The configurations that are applicable to the Organization

FieldDescription
driver_can_registerSpecify if self registration of driver will be allowed
vehicle_typesTypes of vehicle available

Documents

When a driver registers for an organization or a registered driver registers a vehicle, based on the policy of the organization there may be a need to verify certain legal documents.

With this, the organization can specify which files are required.

FieldDescription
nameName of the document
targetIntended target for the document (driver or vehicle)
expiry_requiredIf Expiry Date is applicable for the document
filesFiles that are required to upload. Eg Front and Back of driving license

Driver

Driver can be created by an Admin or have an option to register for themselves.

When a driver is registered, the driver needs to upload certain legal documents for verifications. The documents that are required can be customized by a Organization based on their policies.

After uploading the documents, an organization's admin needs to manually approve the driver's verification status.

The documents will be based on the configuration defined by the organization. Check here

Vehicle

When the driver is approved by the Organization, they will have the ability to register their vehicles with the appropriate documents (requirements will be based on the organization's policies). However vehicle details will be common and required for all organization.

Vehicle Details

FieldDescription
req_noRegistration Number of the Vehicle
manufacturerManufacturer of the Vehicle
modelModel of the Vehicle
yearYear the Vehicle was made
energy_typeThe type of fuel the vehicle needs
typeType of the vehicle defined by the organization (eg. Bike, Taxi)
extrasAny extra information about the vehicle

On this page