How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Onfido Webhooks API

The Webhooks API from Onfido — 3 operation(s) for webhooks.

Onfido Webhooks API is one of 45 APIs that Onfido publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 6 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0, at version v3.6.

Requests are made against a single base URL, https://api.{region}.onfido.com/v3.6.

6 operations 3 paths 21 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v3.6
Server
https://api.{region}.onfido.com/v3.6
Authentication
API Key
Contact
License
MIT
Resource Areas
1

Authentication & Security 1

Onfido Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Token). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 6
GET
/webhooks
List webhooks
list_webhooks → 200default
POST
/webhooks
Register webhook
create_webhook body → 201default
DELETE
/webhooks/{webhook_id}
Delete a webhook
delete_webhook 1 param → 204default
GET
/webhooks/{webhook_id}
Retrieve a Webhook
find_webhook 1 param → 200default
PUT
/webhooks/{webhook_id}
Edit a webhook
update_webhook 1 param body → 200default
POST
/webhooks/resend
Resends webhooks
resend_webhooks body → 204422default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are webhook_event_payload_resource (15 properties), webhook_event_payload_object (5 properties), workflow_run_link (5 properties), webhook_event_payload (4 properties). Each schema is shown below with its type and property counts.

ErrorProperties
object
3 properties
webhook_event_object_status
string
The current state of the object, if available.
workflow_run_link
object
5 properties
webhook_event_type
string
webhook_create
object
1 property 1 required
webhook_event_payload
object
4 properties 3 required
webhook_event
object
1 property
webhook_event_resource_type
string
webhook_builder
webhook_event_payload_resource
object
The resource affected by this event.
15 properties
Webhooks_list
object
1 property 1 required
webhook_event_payload_object
object
The object affected by this event.
5 properties 2 required
webhook_updater
webhook_update
object
1 property
Webhooks_resend_item
object
2 properties 2 required
webhook_shared
object
4 properties
webhook_response
object
4 properties 1 required
Error
object
1 property
webhook
webhook_resend
object
1 property
workflow_run_error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onfido-webhooks-api-openapi.yml Raw ↑

Other APIs Onfido publishes across the network.

Onfido Addresses API
Onfido Applicants API
Onfido Attempts API
Onfido Cancel API
Onfido Capture API
Onfido Captures API
Onfido Checks API
Onfido Complete API
Onfido Documents API
Onfido Download API
Onfido Downloads API
Onfido Electronic API
Where this information came from

This is an independent, third-party profile of Onfido Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.