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

Wingspan Document Signing and Eligibility API

Focuses on endpoints for managing eligibility requirements and custom fields related to payments.

Wingspan Document Signing and Eligibility API is one of 15 APIs that Wingspan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document Signing and Eligibility. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 6 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0-oas3.1.

Requests are made against 2 base URLs: https://api.wingspan.app, https://stagingapi.wingspan.app.

14 operations 6 paths 10 schemas 3 DELETE5 GET4 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0-oas3.1
Base URL
https://api.wingspan.app
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Wingspan Document Signing and Eligibility API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 14

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

Document Signing and Eligibility 14

Focuses on endpoints for managing eligibility requirements and custom fields related to payments.

POST
/payments/collaborator-settings/eligibility-requirement
Establish a new Eligibility Requirement
establishEligibilityRequirement body → 200
GET
/payments/collaborator-settings/eligibility-requirement
Retrieve all Eligibility Requirements
listEligibilityRequirements → 200
GET
/payments/collaborator-settings/eligibility-requirement/{id}
Retrieve a Specific Eligibility Requirement
getEligibilityRequirement 1 param → 200
PATCH
/payments/collaborator-settings/eligibility-requirement/{id}
Modify a Specific Eligibility Requirement
updateEligibilityRequirement 1 param body → 200
DELETE
/payments/collaborator-settings/eligibility-requirement/{id}
Remove a Specific Eligibility Requirement
deleteEligibilityRequirement 1 param → 200
POST
/payments/collaborator-settings/payment-eligibility
Add a New Payment Eligibility Requirement
createPaymentEligibilityRequirement body → 200
GET
/payments/collaborator-settings/payment-eligibility
Retrieve All Payment Eligibility Requirements
listPaymentEligibilityRequirements → 200
GET
/payments/collaborator-settings/payment-eligibility/{id}
Retrieve details of a specific Payment Eligibility Requirement
getPaymentEligibilityRequirement 1 param → 200
PATCH
/payments/collaborator-settings/payment-eligibility/{id}
Modify a specific Payment Eligibility Requirement
updatePaymentEligibilityRequirement 1 param body → 200
DELETE
/payments/collaborator-settings/payment-eligibility/{id}
Remove a specific Payment Eligibility Requirement
deletePaymentEligibilityRequirement 1 param → 200
DELETE
/payments/collaborator-group/{id}/eligibility-requirement/{eligibilityRequirementId}
Remove Eligibility Requirement from Collaborator Group
deleteEligibilityRequirementCollaboratorGroup 2 params → 200
PATCH
/payments/collaborator-group/{id}/eligibility-requirement/{eligibilityRequirementId}
Modify Eligibility Requirement for Collaborator Group
updateEligibilityRequirementCollaboratorGroup 2 params body → 200
GET
/payments/collaborator-group/{id}
Retrieve Specific Collaborator Group Configuration
getCollaboratorGroupConfiguration 1 param → 200
PATCH
/payments/collaborator-group/{id}
Modify Collaborator Group Configuration
updateCollaboratorGroupConfiguration 1 param body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CollaboratorGroupResponse (7 properties), EligibilityRequirement (5 properties), CollaboratorGroupUpdateRequest (4 properties), EligibilityRequirementCreateRequest (3 properties). Each schema is shown below with its type and property counts.

EligibilityRequirementUpdateRequest
object
3 properties 1 required
CollaboratorGroupRequirementUpdate
object
1 property 1 required
CollaboratorGroupResponse
object
7 properties 5 required
CollaboratorGroupRequirement
object
1 property
EligibilityRequirement
object
5 properties 3 required
CollaboratorGroupUpdateRequest
object
4 properties
PaymentEligibilityUpdateRequest
object
2 properties
EligibilityRequirementCreateRequest
object
3 properties 1 required
LabelsDictionary
object
PaymentEligibility
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wingspan-document-signing-and-eligibility-api-openapi.yml Raw ↑

Other APIs Wingspan publishes across the network.

Wingspan 1099 Operations API
Wingspan Banking Management API
Wingspan Bulk Operations API
Wingspan Client Management API
Wingspan Collaborator Management API
Wingspan Custom Field Management API
Wingspan Deprecated API
Wingspan Invoice Management API
Wingspan Merchant Category Codes API
Wingspan Payables Management API
Wingspan Payroll Settings API
Wingspan Reporting and Analytics API