apimatic-plaid-sdk 0.0.2

package/src/models/incomeVerificationPrecheckRequest.ts

@@ -0,0 +1,66 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  nullable,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  IncomeVerificationPrecheckEmployer,
+  incomeVerificationPrecheckEmployerSchema,
+} from './incomeVerificationPrecheckEmployer.js';
+import {
+  IncomeVerificationPrecheckMilitaryInfo,
+  incomeVerificationPrecheckMilitaryInfoSchema,
+} from './incomeVerificationPrecheckMilitaryInfo.js';
+import {
+  IncomeVerificationPrecheckUser,
+  incomeVerificationPrecheckUserSchema,
+} from './incomeVerificationPrecheckUser.js';
+
+/** IncomeVerificationPrecheckRequest defines the request schema for `/income/verification/precheck` */
+export interface IncomeVerificationPrecheckRequest {
+  /** Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. */
+  clientId?: string;
+  /** Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. */
+  secret?: string;
+  user?: IncomeVerificationPrecheckUser;
+  employer?: IncomeVerificationPrecheckEmployer;
+  /** The access token associated with the Item data is being requested for. */
+  transactionsAccessToken?: string | null;
+  usMilitaryInfo?: IncomeVerificationPrecheckMilitaryInfo;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationPrecheckRequestSchema: Schema<IncomeVerificationPrecheckRequest> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        clientId: ['client_id', optional(string())],
+        secret: ['secret', optional(string())],
+        user: ['user', optional(incomeVerificationPrecheckUserSchema)],
+        employer: [
+          'employer',
+          optional(incomeVerificationPrecheckEmployerSchema),
+        ],
+        transactionsAccessToken: [
+          'transactions_access_token',
+          optional(nullable(string())),
+        ],
+        usMilitaryInfo: [
+          'us_military_info',
+          optional(incomeVerificationPrecheckMilitaryInfoSchema),
+        ],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/incomeVerificationPrecheckResponse.ts

@@ -0,0 +1,40 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { Confidence, confidenceSchema } from './confidence.js';
+
+/** IncomeVerificationPrecheckResponse defines the response schema for `/income/verification/precheck`. */
+export interface IncomeVerificationPrecheckResponse {
+  /** ID of the precheck. */
+  precheckId: string;
+  /** A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. */
+  requestId: string;
+  /**
+   * The confidence that Plaid can support the user in the income verification flow. One of the following:
+   * `"HIGH"`: This precheck information submitted is definitively tied to a Plaid-supported integration.
+   * "`LOW`": This precheck information submitted is known not to be supported by Plaid.
+   * `"UNKNOWN"`: It was not possible to determine if the user is supportable with the information passed.
+   */
+  confidence: Confidence;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationPrecheckResponseSchema: Schema<IncomeVerificationPrecheckResponse> = typedExpandoObject(
+  {
+    precheckId: ['precheck_id', string()],
+    requestId: ['request_id', string()],
+    confidence: ['confidence', confidenceSchema],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/incomeVerificationPrecheckUser.ts

@@ -0,0 +1,42 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  nullable,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { AddressData1, addressData1Schema } from './addressData1.js';
+
+export interface IncomeVerificationPrecheckUser {
+  /** The user's first name */
+  firstName?: string | null;
+  /** The user's last name */
+  lastName?: string | null;
+  /** The user's email address */
+  emailAddress?: string | null;
+  /** Data about the components comprising an address. */
+  homeAddress?: AddressData1;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationPrecheckUserSchema: Schema<IncomeVerificationPrecheckUser> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        firstName: ['first_name', optional(nullable(string()))],
+        lastName: ['last_name', optional(nullable(string()))],
+        emailAddress: ['email_address', optional(nullable(string()))],
+        homeAddress: ['home_address', optional(addressData1Schema)],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/incomeVerificationRefreshRequest.ts

@@ -0,0 +1,41 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  nullable,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** IncomeVerificationRefreshRequest defines the request schema for `/income/verification/refresh` */
+export interface IncomeVerificationRefreshRequest {
+  /** Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. */
+  clientId?: string;
+  /** Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. */
+  secret?: string;
+  /** The ID of the verification. */
+  incomeVerificationId?: string | null;
+  /** The access token associated with the Item data is being requested for. */
+  accessToken?: string | null;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationRefreshRequestSchema: Schema<IncomeVerificationRefreshRequest> = typedExpandoObject(
+  {
+    clientId: ['client_id', optional(string())],
+    secret: ['secret', optional(string())],
+    incomeVerificationId: [
+      'income_verification_id',
+      optional(nullable(string())),
+    ],
+    accessToken: ['access_token', optional(nullable(string()))],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/incomeVerificationRefreshResponse.ts

@@ -0,0 +1,34 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** IncomeVerificationRequestResponse defines the response schema for `/income/verification/refresh` */
+export interface IncomeVerificationRefreshResponse {
+  /** A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. */
+  requestId: string;
+  /**
+   * The verification refresh status. One of the following:
+   * `"VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED"` User presence is required to refresh an income verification.
+   */
+  verificationRefreshStatus: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationRefreshResponseSchema: Schema<IncomeVerificationRefreshResponse> = typedExpandoObject(
+  {
+    requestId: ['request_id', string()],
+    verificationRefreshStatus: ['verification_refresh_status', string()],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/incomeVerificationStatusWebhook.ts

@@ -0,0 +1,43 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Fired when the status of an income verification instance has changed. It will typically take several minutes for this webhook to fire after the end user has uploaded their documents in the Document Income flow. */
+export interface IncomeVerificationStatusWebhook {
+  /** `"INCOME"` */
+  webhookType: string;
+  /** `income_verification` */
+  webhookCode: string;
+  /** The `income_verification_id` of the verification instance whose status is being reported. */
+  incomeVerificationId: string;
+  /**
+   * `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed.
+   * `VERIFICATION_STATUS_UPLOAD_ERROR`: An upload error occurred when the end user attempted to upload their verification documentation.
+   * `VERIFICATION_STATUS_INVALID_TYPE`: The end user attempted to upload verification documentation in an unsupported file format.
+   * `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid paystub.
+   * `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.
+   */
+  verificationStatus: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationStatusWebhookSchema: Schema<IncomeVerificationStatusWebhook> = typedExpandoObject(
+  {
+    webhookType: ['webhook_type', string()],
+    webhookCode: ['webhook_code', string()],
+    incomeVerificationId: ['income_verification_id', string()],
+    verificationStatus: ['verification_status', string()],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/incomeVerificationSummaryGetRequest.ts

@@ -0,0 +1,41 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  nullable,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** IncomeVerificationSummaryGetRequest defines the request schema for `/income/verification/summary/get`. */
+export interface IncomeVerificationSummaryGetRequest {
+  /** Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. */
+  clientId?: string;
+  /** Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. */
+  secret?: string;
+  /** The ID of the verification. */
+  incomeVerificationId?: string | null;
+  /** The access token associated with the Item data is being requested for. */
+  accessToken?: string | null;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationSummaryGetRequestSchema: Schema<IncomeVerificationSummaryGetRequest> = typedExpandoObject(
+  {
+    clientId: ['client_id', optional(string())],
+    secret: ['secret', optional(string())],
+    incomeVerificationId: [
+      'income_verification_id',
+      optional(nullable(string())),
+    ],
+    accessToken: ['access_token', optional(nullable(string()))],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/incomeVerificationSummaryGetResponse.ts

@@ -0,0 +1,41 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  lazy,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { Error, errorSchema } from './error.js';
+import { IncomeSummary, incomeSummarySchema } from './incomeSummary.js';
+
+/** IncomeVerificationSummaryGetResponse defines the response schema for `/income/verification/summary/get`. */
+export interface IncomeVerificationSummaryGetResponse {
+  /** A list of income summaries. */
+  incomeSummaries: IncomeSummary[];
+  /** We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues.  Error fields will be `null` if no error has occurred. */
+  error?: Error;
+  /** A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. */
+  requestId: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationSummaryGetResponseSchema: Schema<IncomeVerificationSummaryGetResponse> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        incomeSummaries: ['income_summaries', array(incomeSummarySchema)],
+        error: ['error', optional(errorSchema)],
+        requestId: ['request_id', string()],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/incomeVerificationTaxformsGetRequest.ts

@@ -0,0 +1,41 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  nullable,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** IncomeVerificationTaxformsGetRequest defines the request schema for `/income/verification/taxforms/get` */
+export interface IncomeVerificationTaxformsGetRequest {
+  /** Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. */
+  clientId?: string;
+  /** Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. */
+  secret?: string;
+  /** The ID of the verification. */
+  incomeVerificationId?: string | null;
+  /** The access token associated with the Item data is being requested for. */
+  accessToken?: string | null;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationTaxformsGetRequestSchema: Schema<IncomeVerificationTaxformsGetRequest> = typedExpandoObject(
+  {
+    clientId: ['client_id', optional(string())],
+    secret: ['secret', optional(string())],
+    incomeVerificationId: [
+      'income_verification_id',
+      optional(nullable(string())),
+    ],
+    accessToken: ['access_token', optional(nullable(string()))],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/incomeVerificationTaxformsGetResponse.ts

@@ -0,0 +1,47 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  lazy,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  DocumentMetadata,
+  documentMetadataSchema,
+} from './documentMetadata.js';
+import { Error, errorSchema } from './error.js';
+import { Taxform, taxformSchema } from './taxform.js';
+
+/** IncomeVerificationTaxformsGetResponse defines the response schema for `/income/verification/taxforms/get` */
+export interface IncomeVerificationTaxformsGetResponse {
+  /** A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. */
+  requestId?: string;
+  /** A list of taxforms. */
+  taxforms: Taxform[];
+  documentMetadata: DocumentMetadata[];
+  /** We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues.  Error fields will be `null` if no error has occurred. */
+  error?: Error;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationTaxformsGetResponseSchema: Schema<IncomeVerificationTaxformsGetResponse> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        requestId: ['request_id', optional(string())],
+        taxforms: ['taxforms', array(taxformSchema)],
+        documentMetadata: ['document_metadata', array(documentMetadataSchema)],
+        error: ['error', optional(errorSchema)],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/incomeVerificationWebhookStatus.ts

@@ -0,0 +1,24 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface IncomeVerificationWebhookStatus {
+  id: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const incomeVerificationWebhookStatusSchema: Schema<IncomeVerificationWebhookStatus> = typedExpandoObject(
+  { id: ['id', string()] },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/inflowModel.ts

@@ -0,0 +1,46 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  number,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** The `inflow_model` allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the `inflow_model` will appear in addition to randomly generated test data or transactions specified by `override_accounts`. */
+export interface InflowModel {
+  /**
+   * Inflow model. One of the following:
+   * `none`: No income
+   * `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month
+   * `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.
+   */
+  type: string;
+  /** Amount of income per month. This value is required if `type` is `monthly-income`. */
+  incomeAmount: number;
+  /** Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`. */
+  paymentDayOfMonth: number;
+  /** The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`. */
+  transactionName: string;
+  /** Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if `type` is `monthly-balance-payment` or `monthly-interest-only-payment`. */
+  statementDayOfMonth: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const inflowModelSchema: Schema<InflowModel> = typedExpandoObject(
+  {
+    type: ['type', string()],
+    incomeAmount: ['income_amount', number()],
+    paymentDayOfMonth: ['payment_day_of_month', number()],
+    transactionName: ['transaction_name', string()],
+    statementDayOfMonth: ['statement_day_of_month', string()],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/initialUpdateWebhook.ts

@@ -0,0 +1,42 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  nullable,
+  number,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Fired when an Item's initial transaction pull is completed. Once this webhook has been fired, transaction data for the most recent 30 days can be fetched for the Item. If [Account Select v2](https://plaid.com/docs/link/customization/#account-select) is enabled, this webhook will also be fired if account selections for the Item are updated, with `num_transactions` set to the number of net new transactions pulled after the account selection update. */
+export interface InitialUpdateWebhook {
+  /** `TRANSACTIONS` */
+  webhookType: string;
+  /** `INITIAL_UPDATE` */
+  webhookCode: string;
+  /** The error code associated with the webhook. */
+  error?: string | null;
+  /** The number of new, unfetched transactions available. */
+  newTransactions: number;
+  /** The `item_id` of the Item associated with this webhook, warning, or error */
+  itemId: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const initialUpdateWebhookSchema: Schema<InitialUpdateWebhook> = typedExpandoObject(
+  {
+    webhookType: ['webhook_type', string()],
+    webhookCode: ['webhook_code', string()],
+    error: ['error', optional(nullable(string()))],
+    newTransactions: ['new_transactions', number()],
+    itemId: ['item_id', string()],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/institution.ts

@@ -0,0 +1,84 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  boolean,
+  lazy,
+  nullable,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { AuthMetadata, authMetadataSchema } from './authMetadata.js';
+import { CountryCode, countryCodeSchema } from './countryCode.js';
+import {
+  InstitutionStatus,
+  institutionStatusSchema,
+} from './institutionStatus.js';
+import {
+  PaymentInitiationMetadata,
+  paymentInitiationMetadataSchema,
+} from './paymentInitiationMetadata.js';
+import { Products, productsSchema } from './products.js';
+
+/** Details relating to a specific financial institution */
+export interface Institution {
+  /** Unique identifier for the institution */
+  institutionId: string;
+  /** The official name of the institution */
+  name: string;
+  /** A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return `auth` in the product array; institutions that do not list `auth` may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. For more details, see [Full Auth coverage](https://plaid.com/docs/auth/coverage/). */
+  products: Products[];
+  /** A list of the country codes supported by the institution. */
+  countryCodes: CountryCode[];
+  /** The URL for the institution's website */
+  url?: string | null;
+  /** Hexadecimal representation of the primary color used by the institution */
+  primaryColor?: string | null;
+  /** Base64 encoded representation of the institution's logo */
+  logo?: string | null;
+  /** A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution. */
+  routingNumbers: string[] | null;
+  /** Indicates that the institution has an OAuth login flow. This is primarily relevant to institutions with European country codes. */
+  oauth: boolean;
+  /**
+   * The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data.
+   * Institution status is accessible in the Dashboard and via the API using the `/institutions/get_by_id` endpoint with the `include_status` option set to true. Note that institution status is not available in the Sandbox environment.
+   */
+  status?: InstitutionStatus;
+  /** Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests. */
+  paymentInitiationMetadata?: PaymentInitiationMetadata;
+  /** Metadata that captures information about the Auth features of an institution. */
+  authMetadata?: AuthMetadata;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const institutionSchema: Schema<Institution> = lazy(() =>
+  typedExpandoObject(
+    {
+      institutionId: ['institution_id', string()],
+      name: ['name', string()],
+      products: ['products', array(productsSchema)],
+      countryCodes: ['country_codes', array(countryCodeSchema)],
+      url: ['url', optional(nullable(string()))],
+      primaryColor: ['primary_color', optional(nullable(string()))],
+      logo: ['logo', optional(nullable(string()))],
+      routingNumbers: ['routing_numbers', nullable(array(string()))],
+      oauth: ['oauth', boolean()],
+      status: ['status', optional(institutionStatusSchema)],
+      paymentInitiationMetadata: [
+        'payment_initiation_metadata',
+        optional(paymentInitiationMetadataSchema),
+      ],
+      authMetadata: ['auth_metadata', optional(authMetadataSchema)],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);