iProov · OpenAPI Overlay 1.0.0

iProov REST API — API Evangelist enhancements

14 actions 14 updates update extends ../openapi/_original/iproov-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for iProov's API. It is a proposal applied on top of the contract, not a document iProov publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-mcp-toolx-flowx-flow-stepx-agent-readonlyx-flow-notex-agent-destructivex-api-evangelist-aidx-regional-base-urls-note

Targets 14

$.info
$.servers
$.paths['/availability'].get
$.paths['/claim/enrol/token'].post
$.paths['/claim/enrol/validate'].post
$.paths['/claim/enrol/image'].post
$.paths['/claim/verify/token'].post
$.paths['/claim/verify/validate'].post
$.paths['/claim/verify/image'].post
$.paths['/claim/{token}/invalidate'].post
$.paths['/{api_key}/access_token'].post
$.paths['/users/{existing_user_id}'].get
$.paths['/users/{existing_user_id}'].put
$.paths['/users/{existing_user_id}'].delete

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: iProov REST API — API Evangelist enhancements
  version: 1.0.0
x-generated: '2026-10-18'
x-method: generated
extends: ../openapi/_original/iproov-openapi.yml
actions:
- target: $.info
  update:
    x-api-evangelist-aid: iproov:iproov-rest-api
    x-regional-base-urls-note: Base URL is per region and shown in the Service Location of your iPortal service provider (e.g. https://eu.rp.secure.iproov.me/api/v2).
- target: $.servers
  update:
  - url: https://eu.rp.secure.iproov.me/api/v2
    description: EU region (host the contract was fetched from)
- target: $.paths['/availability'].get
  update:
    x-agent-readonly: true
    x-mcp-tool: check_platform_availability
- target: $.paths['/claim/enrol/token'].post
  update:
    x-mcp-tool: generate_enrol_token
    x-flow: enrol
    x-flow-step: 1
- target: $.paths['/claim/enrol/validate'].post
  update:
    x-mcp-tool: validate_enrolment
    x-flow: enrol
    x-flow-step: 3
    x-flow-note: Step 2 is the client SDK capture using the token from step 1.
- target: $.paths['/claim/enrol/image'].post
  update:
    x-mcp-tool: enrol_with_trusted_photo
    x-flow: enrol-trusted-photo
- target: $.paths['/claim/verify/token'].post
  update:
    x-mcp-tool: generate_verify_token
    x-flow: verify
    x-flow-step: 1
- target: $.paths['/claim/verify/validate'].post
  update:
    x-mcp-tool: validate_verification
    x-flow: verify
    x-flow-step: 3
    x-flow-note: Step 2 is the client SDK capture using the token from step 1.
- target: $.paths['/claim/verify/image'].post
  update:
    x-mcp-tool: verify_with_trusted_photo
    x-flow: verify-trusted-photo
- target: $.paths['/claim/{token}/invalidate'].post
  update:
    x-mcp-tool: invalidate_token
    x-agent-destructive: true
- target: $.paths['/{api_key}/access_token'].post
  update:
    x-mcp-tool: get_access_token
- target: $.paths['/users/{existing_user_id}'].get
  update:
    x-mcp-tool: get_user
    x-agent-readonly: true
- target: $.paths['/users/{existing_user_id}'].put
  update:
    x-mcp-tool: update_user
- target: $.paths['/users/{existing_user_id}'].delete
  update:
    x-mcp-tool: delete_user
    x-agent-destructive: true

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/iproov-rest-api-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.