Applications

This page contains information about managing applications/mandates.

Overview

The Applications API is designed to facilitate the management of Verify by Tiller applications and the individuals associated. It offers the following functionality:

Create an application.
Retrieve application details.
Delete the application (and all associated individuals and check data).
Archive the application (to help with record keeping).

❗The words 'application' and 'mandate' are used interchangeably.

Create application

The Application POST endpoint (/ext/applications) is designed for creating new verification applications. This endpoint initiates the verification process by creating an application and sending email invites to the individuals.

It requires application details, mandate type id (see References section), and information about the individuals. The endpoint ensures that each application is uniquely identified and processed, facilitating a structured and efficient verification workflow.

Creates a new application with one or more individuals specified details.

POSThttps://api.tiller-verify.com/api/v1/ext/applications

Authorization

Header parameters

Body

idID

name*Name

reference*Reference

statusextapplications_status (object)

mandate_type*Mandate type

individuals*array of extapplications_individuals (object)

archivedArchived

Response

Body

idID

name*Name

reference*Reference

statusextapplications_status (object)

mandate_type*Mandate type

archivedArchived

available_actionsarray of inline_response_200_1_available_actions (object)

Request

const response = await fetch('https://api.tiller-verify.com/api/v1/ext/applications', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "individuals": [
        {
          "email": "name@gmail.com",
          "first_name": "text",
          "gender": "male",
          "last_name": "text",
          "reference": "text",
          "title": "text"
        }
      ],
      "mandate_type": {},
      "name": "text",
      "reference": "text"
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "reference": "text",
  "status": {
    "status": "text"
  },
  "mandate_type": {},
  "archived": false,
  "available_actions": [
    {
      "name": "text",
      "title": "text"
    }
  ]
}

Example request data:

application_data = {
        "name": "YOUR_APPLICATION_NAME", # A meaningful application name for your business
        "reference": "MANDATE_REFERENCE", # A unique mandate reference
        "mandate_type": 1, # Update ID from references list for your mandate type
        "individuals": [
            {
                "email": "CUSTOMER_EMAIL",
                "title": "Mr", # See references for full list
                "first_name": "FIRST_NAME",
                "middle_name": "", #Optional
                "last_name": "LAST_NAME",
                "date_of_birth": "1980-12-31", #Optional
                "gender": "male",
                "reference": "REFERENCE001" # A unique reference from your system
            } 
            # Additional individuals can be added to this list.
        ]
    }

Retrieve application

The Retrieve Application Endpoint (/ext/applications/{id}) allows you to fetch detailed information about a specific Verify by Tiller application using its unique identifier. This endpoint is useful in actively in monitoring the progress and status of an application, providing comprehensive insights into the progress of the mobile actions, individual checks, status updates, and other relevant data.

Retrieves details of a specific application identified by its ID.

GEThttps://api.tiller-verify.com/api/v1/ext/applications/{id}

Authorization

Path parameters

id*string

Header parameters

Response

Body

idID

name*Name

reference*Reference

status*extapplications_status (object)

mandate_type*Mandate type

individuals*array of inline_response_200_2_individuals (object)

archivedArchived

available_actionsarray of inline_response_200_1_available_actions (object)

Request

const response = await fetch('https://api.tiller-verify.com/api/v1/ext/applications/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "reference": "text",
  "status": {
    "status": "text"
  },
  "mandate_type": {},
  "individuals": [
    {
      "email": "name@gmail.com",
      "title": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "date_of_birth": "2024-05-18",
      "gender": "male",
      "reference": "text",
      "status": {
        "status": "text"
      },
      "terms_accepted": false,
      "address": {
        "flat_appartment_subbuilding": "text",
        "building_number": "text",
        "building_name": "text",
        "road_street": "text",
        "district": "text",
        "town_city": "text",
        "state_province_name": "text",
        "state_province_code": "text",
        "country_code": "text",
        "post_zip_code": "text",
        "date_from": "2024-05-18",
        "date_to": "2024-05-18"
      },
      "completed_actions": [
        {
          "name": "text",
          "title": "text"
        }
      ],
      "checks": [
        {
          "status": {
            "status": "text"
          },
          "name": "text",
          "title": "text",
          "individual_checkfield_result": [
            {
              "result": "text"
            }
          ]
        }
      ]
    }
  ],
  "archived": false,
  "available_actions": [
    {
      "name": "text",
      "title": "text"
    }
  ]
}

Delete application

The Delete Application Endpoint (/ext/applications/{id}), accessible via an HTTP DELETE request, enables clients to permanently remove an application using its unique identifier.

This will delete the application and all individual data associated with that application. It ensures clients can efficiently manage their application records, removing those no longer needed or relevant. All applications are automatically deleted after eight weeks as per our privacy policy.

Deletes the application associated with the provided ID.

DELETEhttps://api.tiller-verify.com/api/v1/ext/applications/{id}

Path parameters

id*string

Response

Request

const response = await fetch('https://api.tiller-verify.com/api/v1/ext/applications/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Archive application

The Archive Application Endpoint (/ext/applications/{id}/archive), which is accessed through an HTTP PATCH request, provides a facility to archive an existing application by its unique identifier.

Archiving an application is a prudent way to manage no longer current records but might be needed for future reference. This functionality helps keep the active application pool manageable and relevant while ensuring that historical data is preserved. Archiving differs from deletion in that it preserves the data rather than removing it, allowing for retrieval and review as usual through the retrieve application endpoint.

Archives the specified application, changing its status but retaining its data.

PATCHhttps://api.tiller-verify.com/api/v1/ext/applications/{id}/archive

Authorization

Path parameters

id*string

Header parameters

Body

object

Response

Body

idID

name*Name

reference*Reference

status*extapplications_status (object)

mandate_type*Mandate type

individuals*array of inline_response_200_2_individuals (object)

archivedArchived

available_actionsarray of inline_response_200_1_available_actions (object)

Request

const response = await fetch('https://api.tiller-verify.com/api/v1/ext/applications/{id}/archive', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "name": "text",
  "reference": "text",
  "status": {
    "status": "text"
  },
  "mandate_type": {},
  "individuals": [
    {
      "email": "name@gmail.com",
      "title": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "date_of_birth": "2024-05-18",
      "gender": "male",
      "reference": "text",
      "status": {
        "status": "text"
      },
      "terms_accepted": false,
      "address": {
        "flat_appartment_subbuilding": "text",
        "building_number": "text",
        "building_name": "text",
        "road_street": "text",
        "district": "text",
        "town_city": "text",
        "state_province_name": "text",
        "state_province_code": "text",
        "country_code": "text",
        "post_zip_code": "text",
        "date_from": "2024-05-18",
        "date_to": "2024-05-18"
      },
      "completed_actions": [
        {
          "name": "text",
          "title": "text"
        }
      ],
      "checks": [
        {
          "status": {
            "status": "text"
          },
          "name": "text",
          "title": "text",
          "individual_checkfield_result": [
            {
              "result": "text"
            }
          ]
        }
      ]
    }
  ],
  "archived": false,
  "available_actions": [
    {
      "name": "text",
      "title": "text"
    }
  ]
}

An archived application will have the following attribute:

"archived": True

PreviousAuthentication NextIndividuals

Last updated 5 months ago