Exchange a public token (create or attach accounts)
const url = 'https://api.tovarifinancial.com/plaid/exchange';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"mode":"create","publicToken":"example","institutionId":"example","institutionName":"example","backfillDays":0,"selectedAccounts":[{"plaidAccountId":"example","name":"example","mask":"example","type":"example","subtype":"example"}],"allowSeparateItem":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.tovarifinancial.com/plaid/exchange \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "mode": "create", "publicToken": "example", "institutionId": "example", "institutionName": "example", "backfillDays": 0, "selectedAccounts": [ { "plaidAccountId": "example", "name": "example", "mask": "example", "type": "example", "subtype": "example" } ], "allowSeparateItem": true }'X-Idempotency-Key is REQUIRED (a missing header is a 400). Both modes refuse a SECOND Plaid item at an institution the org already has connected with 409 INSTITUTION_ALREADY_LINKED, unless allowSeparateItem: true asserts a genuinely different login — create since KAN-624, attach since KAN-629. The refusal is decided BEFORE the Plaid token exchange, so the single-use public token is never consumed and the caller can re-run the same intent through update mode (POST /plaid/items/{id}/relink/complete with purpose attach-target). On attach it is checked after the target 404 / ACCOUNT_ALREADY_LINKED pre-checks.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Optional idempotency key for safe write retries. Every operation that declares this header reads it. Two cases, told apart per operation: (1) where the operation also documents a 409, replaying this key with a different payload returns 409 IDEMPOTENCY_CONFLICT and replaying it with the same payload returns the original response; (2) where it documents no 409, a replay is reconciled optimistically against a unique key column and answers the original 200.
Request Bodyrequired
Section titled “Request Bodyrequired”object
object
Assert that this is a genuinely SEPARATE login at an institution the org already has connected. Absent or false, the request is refused 409 INSTITUTION_ALREADY_LINKED (details carry the existing { itemId, institutionName }) because a second OAuth consent to the same bank can silently de-authorize the accounts on the first item. Honoured on create and attach alike.
object
object
Assert that this is a genuinely SEPARATE login at an institution the org already has connected. Absent or false, the request is refused 409 INSTITUTION_ALREADY_LINKED (details carry the existing { itemId, institutionName }) because a second OAuth consent to the same bank can silently de-authorize the accounts on the first item. Honoured on create and attach alike.
Responses
Section titled “Responses”Linked item + accounts
object
object
object
object
Example
{ "data": { "item": { "status": "active" } }}Validation failed — see errorCode / fieldErrors
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Missing, invalid, or expired bearer token
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.
object
Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.
object
Active policy versions the user has not yet accepted.
object
True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.
Example
{ "errorCode": "EMAIL_NOT_VERIFIED"}Conflict. errorCode is IDEMPOTENCY_CONFLICT when an X-Idempotency-Key was replayed with a different request payload; where the operation instead detects a resource-state conflict it carries that endpoint’s own errorCode (a duplicate name, an import that is no longer committable, an account already linked to a bank connection).
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Internal error (no internal detail leaked)
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}