Skip to main content

Set a custom task expiry date using the API

To set a custom task expiry date, make a POST request to the endpoint:

http://api.passfort.com/4.0/profiles/<uuid:profile_id>/tasks/<uuid:task_id>/expiry

Send a JSON object with the following information:

Key

Type

expire_at

*Required

Date+time

YYYY-MM-DD HH:mm:ss

reason_description

String

reason_categories

*Required

Array of strings. This can't be an empty array.

Reason categories can be one or more of the following:

DOCUMENT_EXPIRY, APPLICATION_ANNIVERSARY, OTHER

Note that setting expire_at to null will restore the default expiry date.

Examples:

Setting a custom expiry for a task because the applicant's passport expires on a specific date. This can overwrite the expiry date automatically calculated if a task needs to be monitored.

{"expire_at": "2023-12-10 00:00:00", "reason_description": "Passport expires on the 10th of December 2023", "reason_categories": ["DOCUMENT_EXPIRY"]}

Resetting the custom expiry with a comment and a reason category:

{"expire_at": null, "reason_description": "Resetting to the original expiry", "reason_categories": ["OTHER"]}'

Sample response:

{
    "check_ids": [],
    "creation_date": "2022-06-21 13:08:40",
    "custom_expiry": {
        "default_expiry_date": "2024-06-10 13:08:50",
        "expiry_at": "2023-06-07 00:00:00",
        "reason_categories": [
            "DOCUMENT_EXPIRY"
        ],
        "reason_description": ""
    },
    "default_expiry_date": "2024-06-10 13:08:50",
    "form_instance_ids": [],
    "id": "ca6c94df-3777-4a7a-8dae-bb10cb20733d",
    "is_complete": true,
    "is_expired": false,
    "is_skipped": false,
    "nearing_expiry": false,
    "needs_check_automation": false,
    "state": "COMPLETED_PASS",
    "type": "INDIVIDUAL_MANUAL_TASK",
    "variant": {
        "description": "Task that will link to registration forms",
        "id": "a7807aa6-8979-4eb4-9a42-404ec2f467f5",
        "name": "Registration task",
        "task_type": "INDIVIDUAL_MANUAL_TASK"
    },
    "will_expire_at": "2023-06-07 00:00:00"
}

Additional information

In this section: