Driftwatch

Plaid / Plaid API (2020-09-14) /

Breakingdirection flip: their tools call this safe

error_type can now return "SIGNAL_ERROR"

What changed

Producer-side tools call this additive. It breaks exhaustive switches, strict parsers and generated client enums.

Affects error_type on IdentityCreationResult reachable from 2 operations.

New value: SIGNAL_ERROR.

can now return "SIGNAL_ERROR"

Who is affected

Code that reads Plaid's IdentityCreationResult objects, used by 186 Plaid operations.

Before and after

WhereBeforeAfter
IdentityCreationResult.error_type"API_ERROR", "ASSET_REPORT_ERROR", "BANK_TRANSFER_ERROR", "CHECK_REPORT_ERROR", "CONSUMER_REPORT_ERROR", "INCOME_VERIFICATION_ERROR", "INSTITUTION_ERROR", "INVALID_INPUT", "INVALID_REQUEST", "INVALID_RESULT", "ITEM_ERROR", "MICRODEPOSITS_ERROR", "OAUTH_ERROR", "PARTNER_ERROR", "PAYMENT_ERROR", "RATE_LIMIT_EXCEEDED", "RECAPTCHA_ERROR", "SANDBOX_ERROR", "TRANSACTIONS_ERROR", "TRANSACTION_ERROR", "TRANSFER_ERROR""API_ERROR", "ASSET_REPORT_ERROR", "BANK_TRANSFER_ERROR", "CHECK_REPORT_ERROR", "CONSUMER_REPORT_ERROR", "INCOME_VERIFICATION_ERROR", "INSTITUTION_ERROR", "INVALID_INPUT", "INVALID_REQUEST", "INVALID_RESULT", "ITEM_ERROR", "MICRODEPOSITS_ERROR", "OAUTH_ERROR", "PARTNER_ERROR", "PAYMENT_ERROR", "RATE_LIMIT_EXCEEDED", "RECAPTCHA_ERROR", "SANDBOX_ERROR", "SIGNAL_ERROR", "TRANSACTIONS_ERROR", "TRANSACTION_ERROR", "TRANSFER_ERROR"
PlaidErrorType"API_ERROR", "ASSET_REPORT_ERROR", "BANK_TRANSFER_ERROR", "CHECK_REPORT_ERROR", "CONSUMER_REPORT_ERROR", "INCOME_VERIFICATION_ERROR", "INSTITUTION_ERROR", "INVALID_INPUT", "INVALID_REQUEST", "INVALID_RESULT", "ITEM_ERROR", "MICRODEPOSITS_ERROR", "OAUTH_ERROR", "PARTNER_ERROR", "PAYMENT_ERROR", "RATE_LIMIT_EXCEEDED", "RECAPTCHA_ERROR", "SANDBOX_ERROR", "TRANSACTIONS_ERROR", "TRANSACTION_ERROR", "TRANSFER_ERROR""API_ERROR", "ASSET_REPORT_ERROR", "BANK_TRANSFER_ERROR", "CHECK_REPORT_ERROR", "CONSUMER_REPORT_ERROR", "INCOME_VERIFICATION_ERROR", "INSTITUTION_ERROR", "INVALID_INPUT", "INVALID_REQUEST", "INVALID_RESULT", "ITEM_ERROR", "MICRODEPOSITS_ERROR", "OAUTH_ERROR", "PARTNER_ERROR", "PAYMENT_ERROR", "RATE_LIMIT_EXCEEDED", "RECAPTCHA_ERROR", "SANDBOX_ERROR", "SIGNAL_ERROR", "TRANSACTIONS_ERROR", "TRANSACTION_ERROR", "TRANSFER_ERROR"

Code that breaks

switch (response.error_type) {
  // existing branches …
  // no branch for "SIGNAL_ERROR"
  default:
    throw new Error("unexpected error_type");
}

Based on Plaid’s published API specification. How severity is decided.