Completion Requirements

Completion Requirements

Signature, photo, and/or notes can be required on a per-task basis for task completion.

NameTypeDescription
signaturebooleanOptional. A signature must be collected to complete this task.
photobooleanOptional. A photo must be collected to complete this task.
notesbooleanOptional. Task completion notes must be submitted to complete this task.
minimumAgeNumberOptional. The recipient's ID must be scanned and their age verified to be greater than or equal to the minimumAge in order to complete the task. Must be in a plan that supports ID verification.
pinbooleanOptional. Default value is null, acceptable values are null, false and true.
📘

Pin

This is an Enterprise only feature, please contact your Onfleet representatives or support for more information. The values as are followed:

  • null no pin is set
  • false a pin is set for the task but not required to finish the task
  • true a pin is set for the task and is required to finish the task

A pin can be configured in Onfleet SMS Communication for providing recipient with the tag; for details on how to do that please see here. Only dropoff tasks with a recipient will have a PIN, pickup tasks or a task without recipients will have no use of a PIN.

📘

Minimum Age

Age Requirement(minimum Age) feature is a Scale plan or higher feature. Please contact your Onfleet representatives or support for more information.

{
		........
    "id": "XZFbOn3PI5jHdRMvUuNnNb~z",
    "timeCreated": 1776734075000,
    "timeLastModified": 1776734109379,
    "organization": "gz6~YVrx7HVI34ecvWOG1LfB",
    "shortId": "9f775238",
    "dependencies": [],
    "state": 0,
    "completeAfter": null,
    "completeBefore": null,
    "pickupTask": false,
    "type": 1,
    "notes": "",
    "requirements": {
        "signature": true,
        "notes": false,
        "photo": true,
        "minimumAge": 0
    },
    .......
}
{
		........
    "id": "XZFbOn3PI5jHdRMvUuNnNb~z",
    "timeCreated": 1776734075000,
    "timeLastModified": 1776734109379,
    "organization": "gz6~YVrx7HVI34ecvWOG1LfB",
    "shortId": "9f775238",
    "dependencies": [],
    "state": 0,
    "completeAfter": null,
    "completeBefore": null,
    "pickupTask": false,
    "type": 1,
    "notes": "",
    "requirements": {
        "signature": false,
        "notes": false,
        "photo": false,
        "minimumAge": 0,
        "pin": true
    }
    .......
}
📘

Pin API response

You will be able to see and query for the pin using GET task. This will be under the pinVerification field in the response.