Mark a task as complete

You can mark a task as complete using the API.

To mark a task as complete:

Find the task ID when you get data about the profile.
If there is more than one task with the same alias, which happens when a task has more than one version, use the task with "is_expired": "false". Note that the task ID is different to the task variant ID, which will not be used for the request.
Note
If you're completing a task yourself via the API, you might choose to pass the task when the check result is Pass and fail the task when the check result returns Fail three times.
Request endpoint:
Complete a task as passed, make a request to the following endpoint and send the task state field as COMPLETED_PASS.
Alternatively, complete the task as failed and make the same request but send the state field as COMPLETED_FAIL.
Request endpoint:
```
POST https://{api_region}/4.0/profiles/{profile_id}/tasks/{task_id}
```
Replace {api_region} with the API URL specific to your region. Use api.us.maxsight.com for the US region, api.eu.maxsight.com for the EU region, or api.ae.maxsight.com for the UAE region.
Note
If you've configured your smart policy to mark the task as complete automatically when the check passes, you don't need to mark the task as complete using the API. Contact support to change your smart policy configuration.
Alternatively, you can leave a task as incomplete and let your users complete it manually.
If needed, approve the profile's product application when all tasks are completed as passed. When a task is completed as failed, you may want to reject the profile's product application.

In this example, we'll pass a Verify identity task.

Sample request body:

{
    "state": "COMPLETED_PASS"
}

Sample response:

{
    "check_ids": [
        "ea70ade9-3de3-1785-203b-68044cd3ecbb"
    ],
    "creation_date": "2019-10-03 13:48:16",
    "form_instance_ids": [ ],
    "id": "a2c4393a-e219-67a4-5ab4-2186952e9038",
    "is_complete": true,
    "is_expired": false,
    "is_skipped": false,
    "state": "COMPLETED_PASS",
    "type": "INDIVIDUAL_VERIFY_IDENTITY",
    "variant": {
        "id": "5562c4e4-4d12-b16a-a151-7c9eed6816e9",
        "name": "Verify identity - Forexo",
        "task_type": "INDIVIDUAL_VERIFY_IDENTITY"
    }
}

The state field replaces the old is_complete key that used to be part of this request. Making the state key equal to COMPLETED_PASS is the same behavior as making the old is_complete key equal to true.

Additional information

About Maxsight's tasks

In this section:

Mark a task as complete

Additional information

Search results