Fulfill a payee eligibility requirement

post

https://api.wingspan.app/v3/onboarding/payee-requirements/{requirementId}/fulfill

Records a synchronous Passing or Failing result supplied by the payer for an ExternalCompletion requirement. Only the payer that owns the requirement may call this operation; other requirement types are rejected. The result is required; this operation never defaults an omitted outcome to passing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

requirementId

string

required

Unique identifier of the requirement instance

Body Params

Body for POST .../requirements/{id}/fulfill. Carries structured fulfillment data plus the external pass/fail result and verifier provenance.

fulfillmentData

object

Type-specific structured result from the verifier or fulfilling party.

result

string

enum

required

External verifier's required pass/fail outcome.

Allowed:

verification

object

External verifier provenance.

notes

string

Optional notes from the fulfilling party.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Requirement fulfilled (synchronous result applied)

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

422Validation error