openapi: 3.2.0 info: description: Inscribe Fraud Detection API Documentation version: 2.0.0 title: Core Resources Open Banking API termsOfService: http://swagger.io/terms/ contact: email: api@inscribe.ai license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.inscribe.ai/api/v2 security: - ApiKeyAuth: [] tags: - name: Open Banking description: 'This endpoint allows you to associate open banking data with an Inscribe customer. There are 2 types of open banking data supported: Plaid and MX. Credit insights for this customer are then generated from this data.' paths: /customers/{customer_id}/open_banking_data: get: tags: - Open Banking summary: List Open Banking Data description: Returns a paginated list of Open Banking Data related to an Inscribe customer. The list is sorted by creation date in ascending order, with the oldest data appearing first. operationId: getOpenBankingData parameters: - name: customer_id in: path description: The Inscribe customer id. example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b required: true schema: type: string format: uuid - in: query name: size description: Set the number of Open Banking Data records to be returned by the request. example: 15 required: true schema: type: integer format: int64 minimum: 1 maximum: 100 - in: query name: cursor description: Send a cursor to retrieve the next set of Open Banking Data records, starting after the cursor. If no cursor is sent, the first set of Open Banking Data records will be returned. example: 9361c7fb-934b-4cac-8e07-4897e590ab94 schema: type: string format: uuid responses: '200': description: Successfully retrieved Open Banking Data records. content: application/json: schema: $ref: '#/components/schemas/ListOpenBankingData' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /customers/{customer_id}/open_banking_data/inscribe_financial_data: post: tags: - Open Banking summary: Upload Open Banking Data (Inscribe Financial Data Format) (BETA) description: Uploads Open Banking Data (Inscribe Financial Data Format) to an Inscribe customer (BETA). See our guide to submitting open banking data here. operationId: uploadInscribeOpenBankingData parameters: - name: customer_id in: path description: The Inscribe customer id. example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b required: true schema: type: string format: uuid requestBody: description: The Open Banking Data (Inscribe Financial Data Format) to be uploaded. content: application/json: schema: $ref: '#/components/schemas/InscribeOpenBankingDataUploadRequest' example: start_date: '2023-01-01' end_datetime: '2023-01-31T23:59:59Z' accounts: - account_name: Checking Gold account_number: '123456789' account_type: PERSONAL account_subtype: PERSONAL_CHECKING available_balance: 1500.85 balance: 1500.85 currency_code: USD guid: 123e4567-e89b-12d3-a456-426614174002 institution_name: Oakwood Clearwater Bank owners: - name: Liam Canpoor address: 123 Main St, Anytown, USA transactions: - amount: -10.15 currency_code: USD date: '2023-01-02' description: Transaction Received on NSF return item 123 guid: 123e4567-e89b-12d3-a456-426614174001 status: COMPLETED - amount: -100.35 currency_code: USD date: '2023-01-06' description: Credit Card Payment to Quail Creek Bank guid: 123e4567-e89b-12d3-a456-426614174050 status: COMPLETED - amount: 2000.35 currency_code: USD date: '2023-01-10' description: Payroll from NYX Bros Gameshop guid: 123e4567-e89b-12d3-a456-426614174020 status: COMPLETED - amount: -120.85 currency_code: USD date: '2023-01-18' description: Florida Lottery Payment guid: 123e4567-e89b-12d3-a456-426614174030 status: COMPLETED - amount: -150.93 currency_code: USD date: '2023-01-19' description: 19/01 WD ACH IRS guid: 123e4567-e89b-12d3-a466-426614174030 status: COMPLETED - amount: 15.11 currency_code: USD date: '2023-01-25' description: Interest Received guid: 123e4587-e89b-12d3-a466-426614174030 status: COMPLETED responses: '200': description: Successfully created a new Open Banking Data. content: application/json: schema: $ref: '#/components/schemas/OpenBankingData' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /customers/{customer_id}/open_banking_data/mx_aggregated_data: post: tags: - Open Banking summary: Upload Open Banking Data (MX Aggregated Data) description: Uploads MX Aggregated Data to an Inscribe customer. MX Aggregated Data is a format made by combining the responses from various MX endpoint requests. Once the request is received, the MX Aggregated Data will be processed by Inscribe’s Credit Insights service. See our guide to submitting open banking data here. operationId: uploadMXAggregatedOpenBankingData parameters: - name: customer_id in: path description: The Inscribe customer id. example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b required: true schema: type: string format: uuid requestBody: description: 'The MX Aggregated to be uploaded. This data should be in JSON format and is a combination of multiple MX endpoint resource responses. These MX endpoint resources are: [Account](https://docs.mx.com/api-reference/platform-api/reference/account-fields), [Transaction](https://docs.mx.com/api-reference/platform-api/reference/transaction-fields) and [Account Owner](https://docs.mx.com/api-reference/atrium/reference/premium-features/account-owner-fields) (optional).' content: application/json: schema: $ref: '#/components/schemas/MXAggregatedDataUploadRequest' example: from_date: '2016-10-13' accounts: - account_number: '5366' apr: 1 apy: 1 available_balance: 1000 available_credit: 1000 balance: 1000 cash_balance: 1000 cash_surrender_value: 1000 created_at: '2016-10-13T17:57:37.000Z' credit_limit: 100 currency_code: USD day_payment_is_due: 20 death_benefit: 1000 guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 holdings_value: 1000 id: '1040434698' imported_at: '2016-10-20T17:57:37.000Z' institution_code: JP Morgan Chase insured_name: Frodo Baggins interest_rate: 1 is_business: false is_closed: false is_hidden: false is_manual: false last_payment: 100 last_payment_at: '2015-10-13T17:57:37.000Z' loan_amount: 1000 matures_on: '2015-10-13T17:57:37.000Z' member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_id: member123 member_is_managed_by_user: false metadata: some metadata minimum_balance: 100 minimum_payment: 10 name: Checking Account nickname: Checking original_balance: 10 pay_out_amount: 10 payment_due_at: '2015-10-13T17:57:37.000Z' payoff_balance: 10 premium_amount: 1 property_type: '1' routing_number: '68899990000000' started_on: '2016-10-20T17:57:37.000Z' subtype: NONE total_account_value: 1 type: CURRENT updated_at: '2016-10-20T18:08:00.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 transactions: - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 account_id: '1040434698' amount: 61.11 category: Federal Tax category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8 check_number_string: '6812' created_at: '2016-10-14T09:43:42.000Z' currency_code: USD date: '2016-10-14' description: 14/10 WD ACH IRS extended_transaction_type: partner_transaction_type guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9 id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9 is_bill_pay: false is_direct_deposit: false is_expense: true is_fee: false is_income: false is_international: false is_overdraft_fee: false is_payroll_advance: false is_recurring: false is_subscription: false latitude: -43.2075 localized_description: This is a localized_description localized_memo: This is a localized_memo longitude: 139.691706 member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_is_managed_by_user: false memo: This is a memo merchant_category_code: 5411 merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea metadata: some metadata original_description: 14/10 WD ACH IRS posted_at: '2016-10-07T06:00:00.000Z' status: POSTED top_level_category: Taxes transacted_at: '2016-10-06T13:00:00.000Z' type: DEBIT updated_at: '2016-10-07T05:49:12.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 account_id: '1040434698' amount: 11.19 category: Bank Fee category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8 check_number_string: '6812' created_at: '2016-10-14T09:43:42.000Z' currency_code: USD date: '2016-10-14' description: Transaction Received on NSF return item 123 extended_transaction_type: partner_transaction_type guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9 id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9 is_bill_pay: false is_direct_deposit: false is_expense: true is_fee: false is_income: false is_international: false is_overdraft_fee: false is_payroll_advance: false is_recurring: false is_subscription: false latitude: -43.2075 localized_description: This is a localized_description localized_memo: This is a localized_memo longitude: 139.691706 member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_is_managed_by_user: false memo: This is a memo merchant_category_code: 5411 merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea metadata: some metadata original_description: Transaction Received on NSF return item 123 posted_at: '2016-10-07T06:00:00.000Z' status: POSTED top_level_category: Fees & Charges transacted_at: '2016-10-06T13:00:00.000Z' type: DEBIT updated_at: '2016-10-07T05:49:12.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 account_id: '1040434698' amount: 1500 category: Paycheck category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db9 check_number_string: '6812' created_at: '2016-10-15T09:43:42.000Z' currency_code: USD date: '2016-10-15' description: Payroll from NYX Bros Gameshop extended_transaction_type: partner_transaction_type guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9 id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9 is_bill_pay: false is_direct_deposit: false is_expense: true is_fee: false is_income: false is_international: false is_overdraft_fee: false is_payroll_advance: false is_recurring: false is_subscription: false latitude: -43.2075 localized_description: This is a localized_description localized_memo: This is a localized_memo longitude: 139.691706 member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_is_managed_by_user: false memo: This is a memo merchant_category_code: 5411 merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea metadata: some metadata original_description: Payroll from NYX Bros Gameshop posted_at: '2016-10-07T06:00:00.000Z' status: POSTED top_level_category: Income transacted_at: '2016-10-06T13:00:00.000Z' type: CREDIT updated_at: '2016-10-07T05:49:12.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 account_id: '1040434698' amount: 150.36 category: Credit Card Payment category_guid: CAT-9588easd-90a4-bb5c-66c8-1812503d0db8 check_number_string: '6812' created_at: '2016-10-18T09:43:42.000Z' currency_code: USD date: '2016-10-18' description: Credit Card Payment to Quail Creek Bank extended_transaction_type: partner_transaction_type guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9 id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9 is_bill_pay: false is_direct_deposit: false is_expense: true is_fee: false is_income: false is_international: false is_overdraft_fee: false is_payroll_advance: false is_recurring: false is_subscription: false latitude: -43.2075 localized_description: This is a localized_description localized_memo: This is a localized_memo longitude: 139.691706 member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_is_managed_by_user: false memo: This is a memo merchant_category_code: 5411 merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea metadata: some metadata original_description: Credit Card Payment to Quail Creek Bank posted_at: '2016-10-07T06:00:00.000Z' status: POSTED top_level_category: Transfer transacted_at: '2016-10-06T13:00:00.000Z' type: DEBIT updated_at: '2016-10-07T05:49:12.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 account_id: '1040434698' amount: 100.21 category: Groceries category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8 check_number_string: '6812' created_at: '2016-10-19T09:43:42.000Z' currency_code: USD date: '2016-10-19' description: KROGER Brook Av. extended_transaction_type: partner_transaction_type guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9 id: transaction-265abee9-889b-df6a-c69b-25157db2bdd9 is_bill_pay: false is_direct_deposit: false is_expense: true is_fee: false is_income: false is_international: false is_overdraft_fee: false is_payroll_advance: false is_recurring: false is_subscription: false latitude: -43.2075 localized_description: This is a localized_description localized_memo: This is a localized_memo longitude: 139.691706 member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_is_managed_by_user: false memo: This is a memo merchant_category_code: 5411 merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea metadata: some metadata original_description: KROGER Brook Av. posted_at: '2016-10-07T06:00:00.000Z' status: POSTED top_level_category: Food & Dining transacted_at: '2016-10-06T13:00:00.000Z' type: DEBIT updated_at: '2016-10-07T05:49:12.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 account_id: '1040434698' amount: 38 category: Amusement category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8 check_number_string: '6812' created_at: '2016-10-19T09:43:42.000Z' currency_code: USD date: '2016-10-19' description: Florida Lottery Payment extended_transaction_type: partner_transaction_type guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9 id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9 is_bill_pay: false is_direct_deposit: false is_expense: true is_fee: false is_income: false is_international: false is_overdraft_fee: false is_payroll_advance: false is_recurring: false is_subscription: false latitude: -43.2075 localized_description: This is a localized_description localized_memo: This is a localized_memo longitude: 139.691706 member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b member_is_managed_by_user: false memo: This is a memo merchant_category_code: 5411 merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea metadata: some metadata original_description: Florida Lottery Payment posted_at: '2016-10-07T06:00:00.000Z' status: POSTED top_level_category: Entertainment transacted_at: '2016-10-06T13:00:00.000Z' type: DEBIT updated_at: '2016-10-07T05:49:12.000Z' user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 user_id: user123 owners: - account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 address: 123 This Way city: Middlesex country: US email: donnie@darko.co first_name: Donnie guid: ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9 last_name: Darko member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b owner_name: Donnie Darko phone: 555-555-5555 postal_code: 00000-0000 state: VA user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54 responses: '200': description: Successfully created a new Open Banking Data. content: application/json: schema: $ref: '#/components/schemas/OpenBankingData' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /customers/{customer_id}/open_banking_data/plaid_asset_report: post: tags: - Open Banking summary: Upload Open Banking Data (Plaid Assets Report) description: Uploads open banking data in the format of a Plaid Asset Report to an Inscribe customer. Once the request is received, the open banking data will be processed by Inscribe’s Credit Insights service. See our guide to submitting open banking data here. operationId: uploadPlaidAssetReportOpenBankingData parameters: - name: customer_id in: path description: The Inscribe customer id. example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b required: true schema: type: string format: uuid requestBody: description: The Plaid Asset Report to be uploaded. This data should be in the format of the GET response to a Plaid Asset Report request which is defined in [Plaid's documentation here](https://plaid.com/docs/api/products/assets/#asset_report-get-response-report). content: application/json: schema: $ref: '#/components/schemas/PlaidAssetsUploadRequest' responses: '200': description: Successfully created a new Open Banking Data. content: application/json: schema: $ref: '#/components/schemas/OpenBankingData' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /customers/{customer_id}/open_banking_data/{open_banking_data_id}: delete: tags: - Open Banking summary: Delete Open Banking Data description: Permanently deletes an Open Banking Data, as well as all accounts and transactions associated with the data. It cannot be undone. operationId: deleteOpenBankingData parameters: - name: customer_id in: path description: The Inscribe customer id. example: efae18a0-05fa-41d2-be8c-481b44aeeee8 required: true schema: type: string format: uuid - name: open_banking_data_id in: path description: The Inscribe Open Banking Data id to be deleted. example: 706ddf9e-3eb7-4cc7-b653-1327b2351afb required: true schema: type: string format: uuid responses: '204': description: Successfully deleted Open Banking Data. '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /customers/{customer_id}/plaid_assets: post: deprecated: true tags: - Open Banking summary: Upload Plaid Asset Report description: 'Uploads a Plaid Asset Report to a customer. Once a Plaid Asset Report is uploaded, it will be processed by Inscribe’s Credit Insights service which returns customer insights derived from the open banking data. **Warning** This endpoint is deprecated. The recommended endpoint is Upload Plaid Asset Report Open Banking Data.' operationId: uploadPlaidAssetReport parameters: - name: customer_id in: path description: The Inscribe customer id. example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b required: true schema: type: string format: uuid requestBody: description: The Plaid Asset Report to be uploaded. This data should be in the format of the GET response to a Plaid Asset Report request which is defined in [Plaid's documentation here](https://plaid.com/docs/api/products/assets/#asset_report-get-response-report) content: application/json: schema: $ref: '#/components/schemas/PlaidAssetsUploadRequest' responses: '200': description: Successfully created a new Plaid Asset Report. content: application/json: schema: $ref: '#/components/schemas/OpenBankingData' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' get: deprecated: true tags: - Open Banking summary: List all Plaid Asset Reports description: 'Returns a paginated list of Plaid Asset Reports related to a customer. The list is sorted by creation date in ascending order, with the oldest data appearing first. **Warning** This endpoint is deprecated. The recommended endpoint is Get Open Banking Data.' operationId: getPlaidAssetReport parameters: - name: customer_id in: path description: The Inscribe customer id. example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b required: true schema: type: string format: uuid - in: query name: size description: Set the number of Plaid Asset Reports to be returned by the request. example: 15 required: true schema: type: integer format: int64 minimum: 1 maximum: 100 - in: query name: cursor description: Send a cursor to retrieve the next set of Plaid Asset Reports, starting after the cursor. If no cursor is sent, the first set of Plaid Asset Reports will be returned. example: 9361c7fb-934b-4cac-8e07-4897e590ab94 schema: type: string format: uuid responses: '200': description: Successfully retrieved Plaid Asset Reports. content: application/json: schema: $ref: '#/components/schemas/ListOpenBankingData' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /customers/{customer_id}/plaid_assets/{plaid_asset_report_id}: delete: deprecated: true tags: - Open Banking summary: Delete a Plaid Asset Report description: 'Permanently deletes a Plaid Asset Report, as well as all accounts and transactions associated with the data. It cannot be undone. **Warning** This endpoint is deprecated. The recommended endpoint is Delete Open Banking Data.' operationId: deletePlaidAssetReport parameters: - name: customer_id in: path description: The Inscribe customer id. example: efae18a0-05fa-41d2-be8c-481b44aeeee8 required: true schema: type: string format: uuid - name: plaid_asset_report_id in: path description: The id of the Plaid Asset Report to be deleted. example: 706ddf9e-3eb7-4cc7-b653-1327b2351afb required: true schema: type: string format: uuid responses: '204': description: Successfully deleted Plaid Asset Report. '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/PermissionDenied' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: MXAggregatedDataUploadRequest: type: object required: - from_date - accounts properties: from_date: type: string format: date description: The from_date parameter that was used when querying the [MX List Transactions resource](https://docs.mx.com/api-reference/atrium/reference/transactions/list-transactions). accounts: type: array description: List of [MX Accounts](https://docs.mx.com/api-reference/platform-api/reference/account-fields) items: type: object required: - account_number - apr - apy - available_balance - available_credit - balance - cash_balance - cash_surrender_value - created_at - credit_limit - currency_code - day_payment_is_due - death_benefit - guid - holdings_value - id - imported_at - institution_code - insured_name - interest_rate - is_closed - is_hidden - is_manual - last_payment - last_payment_at - loan_amount - matures_on - member_guid - member_id - member_is_managed_by_user - metadata - minimum_balance - minimum_payment - name - nickname - original_balance - pay_out_amount - payment_due_at - payoff_balance - premium_amount - routing_number - started_on - subtype - total_account_value - type - updated_at - user_guid - user_id - transactions properties: account_number: type: string account_ownership: type: - string - 'null' annuity_policy_to_date: type: - string - 'null' annuity_provider: type: - string - 'null' annuity_term_year: type: - string - 'null' apr: type: - number - 'null' apy: type: - number - 'null' available_balance: type: number format: double maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 available_credit: type: - number - 'null' balance: type: number format: double maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 cash_balance: type: - number - 'null' cash_surrender_value: type: - number - 'null' created_at: type: string format: date-time credit_limit: type: - number - 'null' currency_code: type: string day_payment_is_due: type: - number - 'null' death_benefit: type: - number - 'null' guid: type: string holdings_value: type: - number - 'null' id: type: - string - 'null' imported_at: type: string format: date-time institution_code: type: - string - 'null' insured_name: type: - string - 'null' interest_rate: type: - number - 'null' is_business: type: boolean is_closed: type: boolean is_hidden: type: boolean is_manual: type: boolean last_payment: type: - number - 'null' last_payment_at: type: - string - 'null' loan_amount: type: - number - 'null' margin_balance: type: - number - 'null' matures_on: type: - string - 'null' member_guid: type: string member_id: type: - string - 'null' member_is_managed_by_user: type: boolean metadata: type: - string - 'null' minimum_balance: type: - number - 'null' minimum_payment: type: - number - 'null' name: type: - string - 'null' nickname: type: - string - 'null' original_balance: type: - number - 'null' format: double maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 pay_out_amount: type: - number - 'null' payment_due_at: type: - string - 'null' payoff_balance: type: - number - 'null' premium_amount: type: - number - 'null' property_type: type: - string - 'null' routing_number: type: - string - 'null' started_on: type: - string - 'null' format: date-time subtype: type: - string - 'null' total_account_value: type: - number - 'null' type: type: - string - 'null' updated_at: type: string format: date-time user_guid: type: string user_id: type: - string - 'null' today_ugl_amount: type: - number - 'null' today_ugl_percentage: type: - number - 'null' owners: description: List of [MX Account Owners](https://docs.mx.com/api-reference/atrium/reference/premium-features/account-owner-fields) associated with the account type: array items: type: object required: - account_guid - address - city - state - country - postal_code - phone - email - owner_name - member_guid - user_guid properties: account_guid: type: string address: type: - string - 'null' city: type: - string - 'null' guid: type: string state: type: - string - 'null' country: type: - string - 'null' postal_code: type: - string - 'null' phone: type: - string - 'null' email: type: - string - 'null' format: email owner_name: type: - string - 'null' member_guid: type: string user_guid: type: string transactions: description: List of [MX transactions](https://docs.mx.com/api-reference/platform-api/reference/transaction-fields) associated with the account type: array items: type: object required: - account_guid - account_id - amount - category - category_guid - check_number_string - created_at - currency_code - date - description - extended_transaction_type - guid - id - is_bill_pay - is_direct_deposit - is_expense - is_fee - is_income - is_international - is_overdraft_fee - is_payroll_advance - is_recurring - is_subscription - latitude - localized_description - localized_memo - longitude - member_guid - member_is_managed_by_user - memo - merchant_category_code - merchant_guid - merchant_location_guid - metadata - original_description - posted_at - status - top_level_category - transacted_at - type - updated_at - user_guid - user_id properties: account_guid: type: string account_id: type: - string - 'null' amount: type: number format: double maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 category: type: - string - 'null' category_guid: type: - string - 'null' check_number_string: type: - string - 'null' created_at: type: string format: date-time currency_code: type: string date: type: string format: date description: type: string extended_transaction_type: type: - string - 'null' guid: type: string id: type: - string - 'null' is_bill_pay: type: - boolean - 'null' is_direct_deposit: type: - boolean - 'null' is_expense: type: - boolean - 'null' is_fee: type: - boolean - 'null' is_income: type: - boolean - 'null' is_international: type: - boolean - 'null' is_manual: type: - boolean - 'null' is_overdraft_fee: type: - boolean - 'null' is_payroll_advance: type: - boolean - 'null' is_recurring: type: - boolean - 'null' is_subscription: type: - boolean - 'null' latitude: type: - number - 'null' localized_description: type: - string - 'null' localized_memo: type: - string - 'null' longitude: type: - number - 'null' member_guid: type: string member_is_managed_by_user: type: - boolean - 'null' memo: type: - string - 'null' merchant_category_code: type: - number - 'null' merchant_guid: type: - string - 'null' merchant_location_guid: type: - string - 'null' metadata: type: - string - 'null' original_description: type: string posted_at: type: - string - 'null' format: date-time status: type: string top_level_category: type: - string - 'null' transacted_at: type: - string - 'null' format: date-time type: type: - string - 'null' updated_at: type: string format: date-time user_guid: type: string user_id: type: - string - 'null' OpenBankingData: type: object properties: id: type: string format: uuid description: Unique identifier for the Open Banking Data. example: 0efae611-b3eb-4b84-8ed0-36f11430f5a2 created_at: type: string format: date-time description: 'Time at which the Open Banking Data was created, in the format: yyyy-MM-dd''T''HH:mm:ssZ' example: '2022-07-14T09:46:10.510Z' state: type: string description: 'The current state of the Open Banking Data, it has the following options: PROCESSING - This Open Banking Data is still being processed. PROCESSED - This Open Banking Data has finished processing and results are available. ERROR_PROCESSING - An error occurred while processing this Open Banking Data. CORRUPT_DATA_DETECTED - This Open Banking Data was found to contain corrupted data and could not be processed.' enum: - PROCESSING - PROCESSED - ERROR_PROCESSING - CORRUPT_DATA_DETECTED example: PROCESSED no_of_bank_accounts: type: integer description: The number of bank accounts present in the Open Banking Data. This value will be 0 until the data is in the PROCESSED state. example: 2 PlaidAssetsUploadRequest: type: object required: - report - warnings - request_id properties: report: type: object required: - asset_report_id - client_report_id - date_generated - days_requested - user - items properties: asset_report_id: type: string description: A unique identifier for the Asset Report. example: Lr7b1341-1n67-T4a5-pl0r-493199h1vahm client_report_id: type: string description: A self-defined identifier for the Asset Report. example: example_client_report_101 date_generated: type: string description: The date and time of the Asset Report being generated. example: '2022-09-21T02:45:13Z' days_requested: type: number description: The duration the Asset Report corresponds to, in days. example: 10 user: type: object description: The information supplied about the user prior to requesting the Asset Report. example: {} items: type: array description: Data returned by Plaid about each of the Items included in the Asset Report. items: type: object example: [] warnings: type: array description: A list of errors relating to the Asset Report generation. items: type: object example: [] request_id: type: string description: A unique identifier for the request. example: TYeVrpGv4LDWXA2 ListOpenBankingData: type: object properties: data: type: array items: $ref: '#/components/schemas/OpenBankingData' description: A map with a data property that contains an array of Open Banking Data records. Each entry in the array is an Open Banking Data object. If no Open Banking Data object is available, the resulting array will be empty. pagination: type: object properties: cursor: type: string format: uuid description: A cursor for use in pagination. This cursor value can be used to request the next set of Open Banking Data records. example: 9361c7fb-934b-4cac-8e07-4897e590ab94 example: data: - id: 3fc4560f-f6dc-4cdd-a076-182a5e92b70b created_at: '2022-07-14T09:46:10.510Z' state: PROCESSED no_of_bank_accounts: 3 - id: 18a51c48-b387-43a3-a405-6eb63c13c70a created_at: '2022-08-04T11:56:01.460Z' state: PROCESSED no_of_bank_accounts: 1 - id: a28df285-baca-47b2-aae0-e3f085a096d2 created_at: '2022-10-15T16:55:32.098Z' state: PROCESSING no_of_bank_accounts: 0 pagination: cursor: a28df285-baca-47b2-aae0-e3f085a096d2 Error: type: object properties: message: type: string example: error message required: - message InscribeOpenBankingDataUploadRequest: type: object required: - start_date - end_datetime - accounts properties: start_date: type: string format: date description: Refers to the beginning date of the data upload period. This should be in 'YYYY-MM-DD' format and represents the day from which the analysis will start at 00:00. example: '2023-01-01' end_datetime: type: string format: date-time description: Marks the ending point of the data upload period. Unlike start_date, this must include both date and time in 'YYYY-MM-DDTHH:MM:SSZ' format, indicating the exact moment the period ends. example: '2023-01-31T23:59:59Z' accounts: type: array description: An array of objects, each representing a bank account with detailed information. items: type: object required: - account_name - account_number - account_type - account_subtype - available_balance - balance - currency_code - guid - transactions - institution_name - owners properties: account_name: type: string description: The name of the account. example: Checking Gold Account account_number: type: string description: The unique identifier number for the account. example: '123456789' account_type: type: string description: General category of the account. example: PERSONAL enum: - PERSONAL - BUSINESS account_subtype: type: - string - 'null' description: More specific type of the account within the general category. example: PERSONAL_CHECKING enum: - PERSONAL_CHECKING - PERSONAL_SAVING - PERSONAL_SOLE_PROPRIETOR available_balance: type: number format: double description: The available balance in the account at the end of the data period, including any pending transactions. maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 example: 2500.5 balance: type: number format: double description: The current total balance of the account at the end of the data period, excluding any pending transactions. maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 example: 2500.5 currency_code: type: string description: The ISO currency code representing the currency of the account. example: USD guid: type: string description: A globally unique identifier for the account, given by the requester. example: 123e4567-e89b-12d3-a456-426614174000 institution_name: type: - string - 'null' description: The name of the financial institution where the account is held. example: Oakwood Clearwater Bank owners: description: An array of objects representing the owners of the account. type: array items: type: object required: - name - address properties: address: type: - string - 'null' description: The address of the account owner. example: 123 Bridge Street, Sampleton, USA name: type: - string - 'null' description: The name of the account owner. example: Alan Johnson transactions: description: An array of transaction objects associated with the account. type: array items: type: object required: - amount - currency_code - date - description - guid - status properties: amount: type: number format: double description: The amount of the transaction. Negative values refer to debit transactions, while positive values refer to credit transactions. maximum: 1.7976931348623157e+308 minimum: -1.7976931348623157e+308 example: -100 currency_code: type: string description: The ISO currency code for the transaction. example: USD date: type: string format: date description: The posted date of the transaction in 'YYYY-MM-DD' format. The posted date is when the transaction is processed and recorded by the bank in the account. example: '2023-01-15' description: type: string description: A brief description of the transaction. example: Grocery Store Payment guid: type: string description: A globally unique identifier for the transaction, given by the requester. example: 123e4567-e89b-12d3-a456-426614174000 status: type: string description: The status of the transaction. example: PENDING enum: - PENDING - COMPLETE responses: PermissionDenied: description: You do not have permission to access this resource. content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Too many requests. The request has been rate limited. For more information, visit our [documentation on rate limiting](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited). content: text/plain: example: Requests are limited to 200 requests over a 5 minute period. Please try again in 30 seconds headers: Retry-After: description: The number of seconds to wait before retrying the request. schema: type: integer example: 30 BadRequest: description: You have provided incorrect data. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The specified resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization x-default: Inscribe externalDocs: description: Find out more about Swagger url: http://swagger.io x-explorer-enabled: false x-samples-enabled: false x-samples-languages: - curl - python - node x-provenance: method: searched source: https://docs.inscribe.ai/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.inscribe.ai/reference/addcustomer.md - https://docs.inscribe.ai/reference/adddocumentrequest.md - https://docs.inscribe.ai/reference/createsession.md - https://docs.inscribe.ai/reference/deletecustomer.md - https://docs.inscribe.ai/reference/deletedocument.md - https://docs.inscribe.ai/reference/deletedocumentrequest.md - https://docs.inscribe.ai/reference/deleteopenbankingdata.md - https://docs.inscribe.ai/reference/deleteplaidassetreport.md - https://docs.inscribe.ai/reference/getbankaccount.md - https://docs.inscribe.ai/reference/getbankaccountcreditanalysis.md - https://docs.inscribe.ai/reference/getbankaccountcreditanalysiscashflowinsights.md - https://docs.inscribe.ai/reference/getbankaccountcreditanalysisexpenditureinsights.md - https://docs.inscribe.ai/reference/getbankaccountcreditanalysisincomeinsights.md - https://docs.inscribe.ai/reference/getbankaccountcreditanalysisloaninsights.md - https://docs.inscribe.ai/reference/getbankaccountcreditanalysisriskinsights.md - https://docs.inscribe.ai/reference/getbankaccounts.md - https://docs.inscribe.ai/reference/getbankaccounttransactions.md - https://docs.inscribe.ai/reference/getcollectsession.md - https://docs.inscribe.ai/reference/getcollectsessions.md - https://docs.inscribe.ai/reference/getcustomer.md - https://docs.inscribe.ai/reference/getcustomercreditanalysis.md - https://docs.inscribe.ai/reference/getcustomercreditanalysiscashflowinsights.md - https://docs.inscribe.ai/reference/getcustomercreditanalysisexpenditureinsights.md - https://docs.inscribe.ai/reference/getcustomercreditanalysisincomeinsights.md - https://docs.inscribe.ai/reference/getcustomercreditanalysisloaninsights.md - https://docs.inscribe.ai/reference/getcustomercreditanalysisriskinsights.md - https://docs.inscribe.ai/reference/getcustomers.md - https://docs.inscribe.ai/reference/getcustomertransactions.md - https://docs.inscribe.ai/reference/getdocumentresults.md - https://docs.inscribe.ai/reference/getdocuments.md - https://docs.inscribe.ai/reference/getopenbankingdata.md - https://docs.inscribe.ai/reference/getplaidassetreport.md - https://docs.inscribe.ai/reference/gettransactioncategories.md - https://docs.inscribe.ai/reference/reachability-check-2.md - https://docs.inscribe.ai/reference/recategorizetransactions.md - https://docs.inscribe.ai/reference/updatecollectsession.md - https://docs.inscribe.ai/reference/updatecustomer.md - https://docs.inscribe.ai/reference/updatedocument.md - https://docs.inscribe.ai/reference/uploaddocuments.md - https://docs.inscribe.ai/reference/uploadinscribeopenbankingdata.md - https://docs.inscribe.ai/reference/uploadmxaggregatedopenbankingdata.md - https://docs.inscribe.ai/reference/uploadplaidassetreport.md - https://docs.inscribe.ai/reference/uploadplaidassetreportopenbankingdata.md merge: pages: 43 deduped: 485 conflicts_kept_first: 0