Individuals

This page contains information about managing the participants of the applications.

Overview

The individual APIs focus on managing individual customers associated with an the applications.

The endpoints include:

• Retrieving individual details: Access the data related to a specific individual associated with an application, including personal details, completed mobile actions, and check details.

• Resending invites: Reissue an invitation by generating a new code and sending an email.

• Resetting individual data: Provides the ability to reset an individual. All information provided by the individual and check information will reset, and a new invite will be emailed.

• Generating individual reports: Retrieves the individual's PDF report that contains their information and check data in a structured format. This PDF should be stored on your system as a durable record of the verification results.

These information captured by the individual and the checks performed are determined by the application type they have been added to.

❗Please note that the terms individuals and customer are used interchangeably.

Retrieve Individual

The Retrieve Individual endpoint is primarily used for fetching data about an individual, including personal information, their current status in the application process, the results of any checks conducted, and a record of their accepted terms and conditions.

Fetches information about an individual based on their unique ID.

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

Authorization

Bearer

Path parameters

id*string

Header parameters

Response

200

Body

application/json

idID

email*Email

title*Title

first_name*First name

middle_nameMiddle name

last_nameLast name

date_of_birthDate of birth

gender*Gender

malefemaleother

referenceReference

status*extapplications_status (object)

terms_accepted*Terms accepted

addressinline_response_200_2_address (object)

completed_actionsarray of inline_response_200_1_available_actions (object)

checks_in_reviewChecks in review

checks_in_pendingChecks in pending

checks_passedChecks passed

checksarray of inline_response_200_2_checks (object)

Request

JavaScriptCurl

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

Response

{
  "email": "[e-mail]",
  "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"
        }
      ]
    }
  ]
}

Reset Individual

The Reset Individual endpoint will delete all information captured from the customer and all check data. The customer will also receive an email to confirming the reset with a new invite code.

This endpoint is useful when there is a need to clear previously submitted data for an individual, allowing them to restart or re-engage with the application process from a specific point.

Resets all data and status of an individual identified by their ID. A new invite code is emailed to the individual.

POSThttps://api.tiller-verify.com/api/v1/ext/individuals/{id}/reset

Authorization

Bearer

Path parameters

id*string

Header parameters

Body

application/json

object

Response

200

Body

application/json

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

JavaScriptCurl

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

Response

{
  "name": "text",
  "reference": "text",
  "status": {
    "status": "text"
  },
  "mandate_type": {},
  "individuals": [
    {
      "email": "[e-mail]",
      "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"
    }
  ]
}

Retrieve Report

The Retrieve Report endpoint retrieves a detailed PDF report of the individual's application. These reports include the captured personal information, the verification status, the check results and comments collected against the individual. These reports should be downloaded and stored on your system.

❗A report can only be retrieved for an individual that have completed their verification process and are in the 'completed' state.

Generates and retrieves a detailed customer report for the specified individual.

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

Authorization

Bearer

Path parameters

id*string

Header parameters

Response

200

Blob file

Request

JavaScriptCurl

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

Resend Invite

The Resend Invite endpoint resends invitation emails to individuals who have not yet completed their required mobile actions in the verification process. It serves as a tool for prompting and reminding individuals to complete the required mobile app steps.

Customers can also request a new invite code themselves through the mobile app.

Resends an invite code to an individual by email to continue with verification process.

POSThttps://api.tiller-verify.com/api/v1/ext/individuals/{id}/invites/resend

Authorization

Bearer

Path parameters

id*string

Header parameters

Body

application/json

object

Response

201

Body

application/json

object

Request

JavaScriptCurl

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