The server marks this tool destructive: it may delete or overwrite data

onfido_create_applicant

Creates an applicant (person) record in Onfido. Onfido API: POST /applicants. Creates a PII record only — runs NO verification check and costs nothing.

destructive

Argument	Type	Description
dob	string	Date of birth, yyyy-mm-dd.
email	string	Applicant email address.
address	object	Address object (building_number, street, town, postcode, country, …). Passed through as-is.
location	object	Location object (ip_address, country_of_residence, …) for consent tracking. Passed through as-is.
last_name*	string	Applicant's last name (required).
first_name*	string	Applicant's first name (required).
id_numbers	array	Array of id-number objects ({ type, value, state_code? }). Passed through as-is.
phone_number	string	Phone number in E.164 or local format.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "first_name",
    "last_name"
  ],
  "properties": {
    "dob": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Date of birth, yyyy-mm-dd."
    },
    "email": {
      "type": "string",
      "description": "Applicant email address."
    },
    "address": {
      "type": "object",
      "description": "Address object (building_number, street, town, postcode, country, …). Passed through as-is.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "location": {
      "type": "object",
      "description": "Location object (ip_address, country_of_residence, …) for consent tracking. Passed through as-is.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "last_name": {
      "type": "string",
      "description": "Applicant's last name (required)."
    },
    "first_name": {
      "type": "string",
      "description": "Applicant's first name (required)."
    },
    "id_numbers": {
      "type": "array",
      "items": {},
      "description": "Array of id-number objects ({ type, value, state_code? }). Passed through as-is."
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number in E.164 or local format."
    }
  }
}

onfido_get_applicant

Retrieve a single applicant record by id. Onfido API: GET /applicants/{applicant_id}.

read-only

Argument	Type	Description
applicant_id*	string	The applicant id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "applicant_id"
  ],
  "properties": {
    "applicant_id": {
      "type": "string",
      "description": "The applicant id."
    }
  }
}

onfido_get_check

Retrieve a single check (status + report ids + result) by id. Onfido API: GET /checks/{check_id}.

read-only

Argument	Type	Description
check_id*	string	The check id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "check_id": {
      "type": "string",
      "description": "The check id."
    }
  }
}

onfido_get_document

Retrieve a single document's metadata by id. Onfido API: GET /documents/{document_id}.

read-only

Argument	Type	Description
document_id*	string	The document id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "document_id"
  ],
  "properties": {
    "document_id": {
      "type": "string",
      "description": "The document id."
    }
  }
}

onfido_get_report

Retrieve a single report (detailed breakdown + result) by id. Onfido API: GET /reports/{report_id}.

read-only

Argument	Type	Description
report_id*	string	The report id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "report_id"
  ],
  "properties": {
    "report_id": {
      "type": "string",
      "description": "The report id."
    }
  }
}

onfido_get_workflow_run

Retrieve a single Studio workflow run (status, output, task history) by id. Onfido API: GET /workflow_runs/{workflow_run_id}.

read-only

Argument	Type	Description
workflow_run_id*	string	The workflow run id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "workflow_run_id"
  ],
  "properties": {
    "workflow_run_id": {
      "type": "string",
      "description": "The workflow run id."
    }
  }
}

onfido_list_applicants

List applicant (person) records in the Onfido account, paginated. Onfido API: GET /applicants.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
per_page	integer	Results per page (max 500). Default 20.
include_deleted	boolean	Include applicants scheduled for deletion. Default false.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number (1-based). Default 1.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 500,
      "description": "Results per page (max 500). Default 20.",
      "exclusiveMinimum": 0
    },
    "include_deleted": {
      "type": "boolean",
      "description": "Include applicants scheduled for deletion. Default false."
    }
  }
}

onfido_list_checks

List the verification checks run for an applicant (results/status, read-only). Onfido API: GET /checks?applicant_id=….

read-only

Argument	Type	Description
applicant_id*	string	The applicant id whose checks to list (required).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "applicant_id"
  ],
  "properties": {
    "applicant_id": {
      "type": "string",
      "description": "The applicant id whose checks to list (required)."
    }
  }
}

onfido_list_documents

List the identity documents uploaded for an applicant (metadata only). Onfido API: GET /documents?applicant_id=….

read-only

Argument	Type	Description
applicant_id*	string	The applicant id whose documents to list (required).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "applicant_id"
  ],
  "properties": {
    "applicant_id": {
      "type": "string",
      "description": "The applicant id whose documents to list (required)."
    }
  }
}

onfido_list_live_photos

List the live photos captured for an applicant (metadata only). Onfido API: GET /live_photos?applicant_id=….

read-only

Argument	Type	Description
applicant_id*	string	The applicant id whose live photos to list (required).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "applicant_id"
  ],
  "properties": {
    "applicant_id": {
      "type": "string",
      "description": "The applicant id whose live photos to list (required)."
    }
  }
}

onfido_list_live_videos

List the live videos captured for an applicant (metadata only). Onfido API: GET /live_videos?applicant_id=….

read-only

Argument	Type	Description
applicant_id*	string	The applicant id whose live videos to list (required).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "applicant_id"
  ],
  "properties": {
    "applicant_id": {
      "type": "string",
      "description": "The applicant id whose live videos to list (required)."
    }
  }
}

onfido_list_reports

List the individual reports that make up a check (document, facial similarity, watchlist, …). Onfido API: GET /reports?check_id=….

read-only

Argument	Type	Description
check_id*	string	The check id whose reports to list (required).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "check_id"
  ],
  "properties": {
    "check_id": {
      "type": "string",
      "description": "The check id whose reports to list (required)."
    }
  }
}

onfido_list_workflow_runs

List Onfido Studio workflow runs (status/output, read-only — does NOT start a run). Onfido API: GET /workflow_runs.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
sort	string	Sort by creation time. Default desc.
status	string	Filter by status, e.g. processing \| awaiting_input \| approved \| declined \| abandoned \| error.
applicant_id	string	Filter to a single applicant's workflow runs.
created_at_gt	string	Only runs created after this ISO-8601 timestamp.
created_at_lt	string	Only runs created before this ISO-8601 timestamp.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Page number (1-based). Default 1.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort by creation time. Default desc."
    },
    "status": {
      "type": "string",
      "description": "Filter by status, e.g. processing | awaiting_input | approved | declined | abandoned | error."
    },
    "applicant_id": {
      "type": "string",
      "description": "Filter to a single applicant's workflow runs."
    },
    "created_at_gt": {
      "type": "string",
      "description": "Only runs created after this ISO-8601 timestamp."
    },
    "created_at_lt": {
      "type": "string",
      "description": "Only runs created before this ISO-8601 timestamp."
    }
  }
}

onfido_update_applicant

Updates an applicant's details (reversible; runs no verification). Onfido API: PUT /applicants/{applicant_id}.

destructive

Argument	Type	Description
dob	string	Date of birth, yyyy-mm-dd.
email	string	Applicant email address.
address	object	Address object (building_number, street, town, postcode, country, …). Passed through as-is.
last_name	string	Updated last name.
first_name	string	Updated first name.
id_numbers	array	Array of id-number objects ({ type, value, state_code? }). Passed through as-is.
applicant_id*	string	The applicant id to update (required).
phone_number	string	Phone number in E.164 or local format.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "applicant_id"
  ],
  "properties": {
    "dob": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Date of birth, yyyy-mm-dd."
    },
    "email": {
      "type": "string",
      "description": "Applicant email address."
    },
    "address": {
      "type": "object",
      "description": "Address object (building_number, street, town, postcode, country, …). Passed through as-is.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "last_name": {
      "type": "string",
      "description": "Updated last name."
    },
    "first_name": {
      "type": "string",
      "description": "Updated first name."
    },
    "id_numbers": {
      "type": "array",
      "items": {},
      "description": "Array of id-number objects ({ type, value, state_code? }). Passed through as-is."
    },
    "applicant_id": {
      "type": "string",
      "description": "The applicant id to update (required)."
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number in E.164 or local format."
    }
  }
}

Onfido MCP by usefulapi

Try it

onfido_create_applicant Destructive

Onfido MCP by usefulapi

Try it

onfido_create_applicant Destructive

Tools (14)