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

DecisionLink Benefits API

The benefits API from DecisionLink — 7 operation(s) for benefits.

DecisionLink Benefits API is one of 62 APIs that DecisionLink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 7 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.xfactor.io.

8 operations 7 paths 19 schemas 4 GET4 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.xfactor.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

DecisionLink Benefits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

  • HTTPBearer — Access token in the form of a JWT

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 4 GET, 4 PATCH. Each is listed below with its method, path, parameters, and response codes.

benefits 8
GET
/v1/collaboration/valueProps/benefits
Get the Benefits for a Collaboration organized by Value Category
get_benefits_v1_collaboration_valueProps_benefits_get → 200
PATCH
/v1/collaboration/valueProps/benefits/active
Save the Benefit Active statuses for Collaboration benefits
update_benefit_active_status_v1_collaboration_valueProps_benefits_active_patch body → 200422
GET
/v1/value-proposition/{valuePropId}/benefits/{benefitId}
Get the details for a single benefit
get_single_benefit_v1_value_proposition__valuePropId__benefits__benefitId__get 2 params → 200422
PATCH
/v1/value-proposition/{valuePropId}/benefits/{benefitId}
Update benefit phasing and factors
update_benefit_phasing_v1_value_proposition__valuePropId__benefits__benefitId__patch 2 params body → 200422
GET
/v1/value-proposition/{valuePropId}/benefits
Get the Benefits for a Value Proposition by Value Category
get_benefits_v1_value_proposition__valuePropId__benefits_get 5 params → 200422
PATCH
/v1/value-proposition/{valuePropId}/benefits-active
Save the Benefit Active statuses for benefits
update_benefit_active_status_v1_value_proposition__valuePropId__benefits_active_patch 1 param body → 200422
GET
/v1/value-proposition/{valuePropId}/benefits-by-type
Returns the benefits by type(financial/non financial)
get_benefit_by_type_v1_value_proposition__valuePropId__benefits_by_type_get 7 params → 200422
PATCH
/v1/value-proposition/{valuePropId}/benefit-fields/{benefitId}
Update benefit fields
update_benefit_fields_endpoint_v1_value_proposition__valuePropId__benefit_fields__benefitId__patch 2 params body → 200422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are SingleBenefitDetail (146 properties), value_proposition__benefits__models__Benefit (28 properties), ValueCategory_2 (16 properties), BenefitPhasingValue (11 properties). Each schema is shown below with its type and property counts.

BenefitActive
object
BenefitActive model
2 properties 2 required
HTTPValidationError
object
1 property
ValueCategory
object
ValueCategory model
4 properties 4 required
MessageResponse
object
MessageResponse model
1 property 1 required
Benefit
object
Benefit model
4 properties 4 required
BenefitActivePayload
object
BenefitActivePayload model
1 property 1 required
ValidationError
object
3 properties 3 required
BenefitPhasingValue
object
Benefit Phasing Value model
11 properties
SingleBenefitDetail
object
Single Benefit Detail model
146 properties 82 required
BenefitPhasingAndFactorPayload
object
Payload for updating benefit phasing and factors
3 properties
BenefitPhasingUpdateResponse
object
Response model for the benefit phasing and factors update
2 properties 1 required
FilterByOption
string
Filter options for benefits-by-type grouping
ValueCategory_2
object
ValueCategory model
16 properties 15 required
BenefitType
object
BenefitType model
8 properties 4 required
BenefitFieldsPayload
object
Benefit Fields Payload model
7 properties
FactorValue
object
FactorValue model
5 properties 2 required
BenefitsByTypeResponse
object
Benefits by Type Response Model
6 properties 1 required
value_proposition__benefits__models__Benefit
object
Benefit model
28 properties 15 required
MessageResponse_2
object
Response model for simple message responses
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

decisionlink-benefits-api-openapi.yml Raw ↑

Other APIs DecisionLink publishes across the network.

DecisionLink Account Factors API
DecisionLink Account Mappings API
DecisionLink Accrual Types API
DecisionLink Advanced API
DecisionLink Area Types API
DecisionLink Asset Languages API
DecisionLink Assets API
DecisionLink Attributions API
DecisionLink Available Terms API
DecisionLink Baseline Types API
DecisionLink Benefits Calculate API
DecisionLink Benefits One Time API
Where this information came from

This is an independent, third-party profile of DecisionLink Benefits 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.