Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Windfall Windfall API API

The Windfall API API from Windfall — 1 operation(s) for windfall api.

Windfall Windfall API API is published by Windfall on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Windfall API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.windfalldata.com/v1.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.windfalldata.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Windfall Windfall API API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-WF-Auth-Token (ApiToken). By default, every request must be authenticated.

  • ApiToken — Your API token, provided by Windfall. All requests must include this header.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Windfall API 1
POST
/
Enrich a person record
enrichRecord body → 200400401429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are EnrichmentRequest (7 properties), EnrichmentResponse (5 properties), Address (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

EnrichmentResponse
object
Enrichment results for the submitted person record.
5 properties 2 required
EnrichmentRequest
object
A person record to enrich. Provide as many fields as possible for the best match results.
7 properties
Address
object
A property address used during matching.
4 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windfall-windfall-api-api-openapi.yml Raw ↑