Complete partner OAuth (token exchange)

post

https://api.wingspan.app/v3/platform/accounting-connections/{connectionId}/complete-connection

Exchanges the parsed {code, state, realmId}. The only transition into Connected (fires AccountingConnection.Connected). An invalid or expired state returns 422 (integrations.OAuthStateInvalid); a realmId mismatch returns 422 (integrations.RealmMismatch).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

connectionId

string

required

length between 22 and 22

^[A-Za-z0-9_.]{22}$

Unique identifier of an AccountingConnection. A 22-character id.

Body Params

Parsed OAuth callback parameters for the token exchange.

code

string

required

state

string

required

realmId

string

required

The partner's own OAuth-callback company identifier, used as a transient input to the exchange.

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

200Connection now Connected

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

501This operation is not yet available