API Reference

Share tax information with this payer

post
https://api.wingspan.app/v3/payments/payers//share-tax-information

The payee shares its tax information with this payer, against the payee's own Payer relationship record. Sharing is a standing, ongoing grant: the payee's current active ComplianceEntity and every future one is shared, and each automatically projects a certified Auto W-9 into the payer's Forms when Tax-verified. A no-login share binds future identities to its recorded Stakeholder signer; replacing that principal requires fresh consent. Authorized ServiceAccounts or Account Admin Persons may submit externally collected consent for the receiving Account with consent.signerStakeholderId. Machine submission also requires users.authorization:read. Ordinary Person consent remains principal-only. Foreign or missing ComplianceEntity ids return a uniform 422 with detailCode: users.ComplianceEntityNotOwnedByGrantor. Idempotent via Idempotency-Key. Fires Payer.TaxInformationShared.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Za-z0-9_.]{22,80}$
Body Params

Share the payee's tax information with this payer. Sharing is a standing, ongoing grant of the payee's current and future active tax identity.

previousComplianceEntityIds
array of strings
length ≤ 25

Optional no-longer-active ComplianceEntities to additionally share for prior-period needs. Active/current CEs are covered by the standing share and do not belong here. Entries must be owned by the grantor's Account or by the grantor Person's migrated SELF facade.

previousComplianceEntityIds
consent
object
required

Captured attestation and electronic signature backing the share; this is the certification act for any Auto W-9 projected from a covered, Tax-verified ComplianceEntity.

Headers
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).

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

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?