detektu
Plaid API changes
Info

Request property all of added annotation only: subschema-#2

openapi:POST /cra/report/get::request.application.json.subschema-#2
Product
Plaid API
Source
OpenAPI URL
Change kind
Request Property All Of Added Annotation Only
Detected
Last updated

Deterministic evidence

Before / after

Extracted from Plaid's published contract. Shows the whole operation — a narrower excerpt was not available for this change. Open the source ↗

−589+18581 change

1 / 1
"$ref": "#/components/schemas/APIClientID"
"$ref": "#/components/schemas/APIClientID"
},
},
"consumer_report_permissible_purpose": {
"consumer_report_permissible_purpose": {
"$ref": "#/components/schemas/ConsumerReportPermissiblePurpose"
"allOf": [
},
{
"decision_stage": {
"$ref": "#/components/schemas/ConsumerReportPermissiblePurpose"
"$ref": "#/components/schemas/CraReportDecisionStage"
},
},
{}
"products": {
],
"items": {
"x-override-enum-values-shown": [
"discriminator": {
"EXTENSION_OF_CREDIT",
"mapping": {
"LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING",
"cra_base_report": "#/components/schemas/CraBaseReportProduct",
"LEGITIMATE_BUSINESS_NEED_OTHER",
"cra_cashflow_insights": "#/components/schemas/CraCashflowInsightsProduct",
"WRITTEN_INSTRUCTION_PREQUALIFICATION",
"cra_home_lending": "#/components/schemas/CraHomeLendingProduct",
"WRITTEN_INSTRUCTION_OTHER",
"cra_income_insights": "#/components/schemas/CraIncomeInsightsProduct",
"ELIGIBILITY_FOR_GOVT_BENEFITS",
"cra_lend_score": "#/components/schemas/CraLendScoreProduct",
"INSURANCE_UNDERWRITING"
"cra_network_insights": "#/components/schemas/CraNetworkInsightsProduct",
]
"cra_qualify": "#/components/schemas/CraQualifyProduct"
},
},
"decision_stage": {
"propertyName": "product"
"$ref": "#/components/schemas/CraReportDecisionStage"
},
},
"oneOf": [
"products": {
{
"items": {
"additionalProperties": true,
"discriminator": {
"properties": {
"mapping": {
"product": {
"cra_base_report": "#/components/schemas/CraBaseReportProduct",
"enum": [
"cra_cashflow_insights": "#/components/schemas/CraCashflowInsightsProduct",
"cra_qualify"
"cra_home_lending": "#/components/schemas/CraHomeLendingProduct",
],
"cra_income_complete": "#/components/schemas/CraIncomeCompleteBundleProduct",
"type": "string"
"cra_income_insights": "#/components/schemas/CraIncomeInsightsProduct",
},
"cra_lend_score": "#/components/schemas/CraLendScoreProduct",
"version": {
"cra_lend_score_complete": "#/components/schemas/CraLendScoreCompleteBundleProduct",
"$ref": "#/components/schemas/CraProductVersion"
"cra_network_insights": "#/components/schemas/CraNetworkInsightsProduct",
}
"cra_qualify": "#/components/schemas/CraQualifyProduct"
},
},
"required": [
"propertyName": "product"
"product",
},
"version"
"oneOf": [
],
{
"title": "CraQualifyProduct",
"additionalProperties": true,
"type": "object",
"properties": {
"x-hidden-from-docs": true
"product": {
},
"enum": [
{
"cra_qualify"
"additionalProperties": true,
],
"properties": {
"type": "string"
"product": {
},
"enum": [
"version": {
"cra_income_insights"
"$ref": "#/components/schemas/CraProductVersion"
],
}
"type": "string"
},
},
"required": [
"version": {
"product",
"$ref": "#/components/schemas/CraProductVersion"
"version"
}
],
},
"title": "CraQualifyProduct",
"required": [
"type": "object"
"product",
},
"version"
{
],
"additionalProperties": true,
"title": "CraIncomeInsightsProduct",
"properties": {
"type": "object"
"product": {
},
"enum": [
{
"cra_income_insights"
"additionalProperties": true,
],
"properties": {
"type": "string"
"product": {
},
"enum": [
"version": {
"cra_home_lending"
"$ref": "#/components/schemas/CraProductVersion"
],
}
"type": "string"
},
},
"required": [
"version": {
"product",
"$ref": "#/components/schemas/CraProductVersion"
"version"
}
],
},
"title": "CraIncomeInsightsProduct",
"required": [
"type": "object"
"product",
},
"version"
{
],
"additionalProperties": true,
"title": "CraHomeLendingProduct",
"properties": {
"type": "object"
"product": {
},
"enum": [
{
"cra_home_lending"
"additionalProperties": true,
],
"properties": {
"type": "string"
"product": {
},
"enum": [
"version": {
"cra_base_report"
"$ref": "#/components/schemas/CraProductVersion"
],
}
"type": "string"
},
},
"required": [
"version": {
"product",
"$ref": "#/components/schemas/CraProductVersion"
"version"
}
],
},
"title": "CraHomeLendingProduct",
"required": [
"type": "object",
"product",
"x-hidden-from-docs": true
"version"
},
],
{
"title": "CraBaseReportProduct",
"additionalProperties": true,
"type": "object"
"properties": {
},
"product": {
{
"enum": [
"additionalProperties": true,
"cra_base_report"
"properties": {
],
"product": {
"type": "string"
"enum": [
},
"cra_lend_score"
"version": {
],
"$ref": "#/components/schemas/CraProductVersion"
"type": "string"
}
},
},
"version": {
"required": [
"$ref": "#/components/schemas/CraProductVersion"
"product",
}
"version"
},
],
"required": [
"title": "CraBaseReportProduct",
"product",
"type": "object"
"version"
},
],
{
"title": "CraLendScoreProduct",
"additionalProperties": true,
"type": "object"
"properties": {
},
"options": {
{
"nullable": true,
"additionalProperties": true,
"properties": {
"properties": {
"variants": {
"product": {
"items": {
"enum": [
"$ref": "#/components/schemas/CraLendScoreVariant"
"cra_cashflow_insights"
},
],
"type": "array"
"type": "string"
}
},
},
"version": {
"title": "CraReportGetLendScoreOptions",
"$ref": "#/components/schemas/CraProductVersion"
"type": "object"
}
},
},
"product": {
"required": [
"enum": [
"product",
"cra_lend_score"
"version"
],
],
"type": "string"
"title": "CraCashflowInsightsProduct",
},
"type": "object"
"version": {
},
"$ref": "#/components/schemas/CraProductVersion"
{
}
"additionalProperties": true,
},
"properties": {
"required": [
"product": {
"product",
"enum": [
"version"
"cra_network_insights"
],
],
"title": "CraLendScoreProduct",
"type": "string"
"type": "object"
},
},
"version": {
{
"$ref": "#/components/schemas/CraProductVersion"
"additionalProperties": true,
}
"properties": {
},
"product": {
"required": [
"enum": [
"product",
"cra_cashflow_insights"
"version"
],
],
"type": "string"
"title": "CraNetworkInsightsProduct",
},
"type": "object"
"version": {
}
"$ref": "#/components/schemas/CraProductVersion"
],
}
"title": "CraReportGetRequestProduct"
},
},
"required": [
"minItems": 1,
"product",
"type": "array"
"version"
},
],
"report_id": {
"title": "CraCashflowInsightsProduct",
"allOf": [
"type": "object"
{
},
"$ref": "#/components/schemas/CraReportId"
{
},
"additionalProperties": true,
{}
"properties": {
]
"product": {
},
"enum": [
"scope": {
"cra_network_insights"
"$ref": "#/components/schemas/CraReportScope"
],
},
"type": "string"
"secret": {
},
"$ref": "#/components/schemas/APISecret"
"version": {
},
"$ref": "#/components/schemas/CraProductVersion"
"user_id": {
}
"$ref": "#/components/schemas/NewUserID"
},
}
"required": [
},
"product",
"required": [
"version"
"user_id",
],
"products",
"title": "CraNetworkInsightsProduct",
"decision_stage",
"type": "object"
"consumer_report_permissible_purpose"
},
],
{
"title": "CraReportGetRequest",
"additionalProperties": true,
"type": "object"
"properties": {
}
"options": {
}
"nullable": true,
},
"properties": {
"required": true
"variants": {
},
"items": {
"responses": {
"$ref": "#/components/schemas/CraLendScoreVariant"
"200": {
},
"content": {
"type": "array"
"application/json": {
}
"schema": {
},
"additionalProperties": true,
"title": "CraReportGetLendScoreCompleteOptions",
"properties": {
"type": "object"
"client_user_id": {
},
"nullable": true,
"product": {
"type": "string"
"enum": [
},
"cra_lend_score_complete"
"report": {
],
"additionalProperties": true,
"type": "string"
"properties": {
},
"consumer_report_permissible_purpose": {
"version": {
"$ref": "#/components/schemas/ConsumerReportPermissiblePurpose"
"$ref": "#/components/schemas/CraProductVersion"
},
}
"decision_stage": {
},
"$ref": "#/components/schemas/CraReportDecisionStage"
"required": [
},
"product",
"products": {
"version"
"items": {
],
"discriminator": {
"title": "CraLendScoreCompleteBundleProduct",
"mapping": {
"type": "object"
"cra_home_lending": "#/components/schemas/CraReportGetHomeLendingResponseProduct",
},
"cra_income_insights": "#/components/schemas/CraReportGetIncomeInsightsResponseProduct",
{
"cra_qualify": "#/components/schemas/CraReportGetQualifyResponseProduct"
"additionalProperties": true,
},
"properties": {
"propertyName": "product"
"product": {
},
"enum": [
"oneOf": [
"cra_income_complete"
{
],
"additionalProperties": true,
"type": "string"
"properties": {
},
"attributes": {
"version": {
"additionalProperties": {},
"$ref": "#/components/schemas/CraProductVersion"
"nullable": true,
}
"title": "CraReportGetProductAttributes",
},
"type": "object"
"required": [
},
"product",
"errors": {
"version"
"items": {
],
"$ref": "#/components/schemas/PlaidError"
"title": "CraIncomeCompleteBundleProduct",
},
"type": "object"
"type": "array"
}
},
],
"metadata": {
"title": "CraReportGetRequestProduct"
"additionalProperties": {},
},
"nullable": true,
"minItems": 1,
"title": "CraReportGetProductMetadata",
"type": "array",
"type": "object"
"x-override-enum-values-shown": [
},
"cra_qualify",
"product": {
"cra_base_report",
"enum": [
"cra_income_insights",
"cra_qualify"
"cra_cashflow_insights",
],
"cra_lend_score",
"type": "string"
"cra_network_insights",
},
"cra_lend_score_complete",
"version": {
"cra_income_complete"
"$ref": "#/components/schemas/CraProductVersion"
]
}
},
},
"report_id": {
"required": [
"allOf": [
"product",
{
"version",
"$ref": "#/components/schemas/CraReportId"
"metadata",
},
"attributes",
{}
"errors"
]
],
},
"title": "CraReportGetQualifyResponseProduct",
"scope": {
"type": "object",
"$ref": "#/components/schemas/CraReportScope"
"x-hidden-from-docs": true
},
},
"secret": {
{
"$ref": "#/components/schemas/APISecret"
"additionalProperties": true,
},
"properties": {
"user_id": {
"attributes": {
"$ref": "#/components/schemas/NewUserID"
"additionalProperties": true,
}
"nullable": true,
},
"properties": {
"required": [
"income_streams": {
"user_id",
"items": {
"products",
"additionalProperties": true,
"decision_stage",
"properties": {
"consumer_report_permissible_purpose"
"end_date": {
],
"format": "date",
"title": "CraReportGetRequest",
"nullable": true,
"type": "object"
"type": "string"
}
},
}
"income_metrics": {
},
"$ref": "#/components/schemas/CraIncomeMetrics"
"required": true
},
},
"income_stream_id": {
"responses": {
"type": "string"
"200": {
},
"content": {
"insights": {
"application/json": {
"$ref": "#/components/schemas/CraIncomeStreamInsights"
"schema": {
},
"additionalProperties": true,
"start_date": {
"properties": {
"format": "date",
"client_user_id": {
"nullable": true,
"nullable": true,
"type": "string"
"type": "string"
}
},
},
"report": {
"required": [
"additionalProperties": true,
"income_stream_id",
"properties": {
"start_date",
"client_report_id": {
"end_date",
"nullable": true,
"insights",
"type": "string"
"income_metrics"
},
],
"consumer_report_permissible_purpose": {
"title": "CraReportGetIncomeInsightsStream",
"allOf": [
"type": "object"
{
},
"$ref": "#/components/schemas/ConsumerReportPermissiblePurpose"
"type": "array"
},
},
{}
"user_summary": {
],
"$ref": "#/components/schemas/CraIncomeInsightsUserSummary"
"x-override-enum-values-shown": [
}
"EXTENSION_OF_CREDIT",
},
"LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING",
"required": [
"LEGITIMATE_BUSINESS_NEED_OTHER",
"income_streams",
"WRITTEN_INSTRUCTION_PREQUALIFICATION",
"user_summary"
"WRITTEN_INSTRUCTION_OTHER",
],
"ELIGIBILITY_FOR_GOVT_BENEFITS",
"title": "CraReportGetIncomeInsightsAttributes",
"INSURANCE_UNDERWRITING"
"type": "object"
]
},
},
"errors": {
"decision_stage": {
"items": {
"$ref": "#/components/schemas/CraReportDecisionStage"
"$ref": "#/components/schemas/PlaidError"
},
},
"products": {
"type": "array"
"items": {
},
"discriminator": {
"metadata": {
"mapping": {
"additionalProperties": true,
"cra_base_report": "#/components/schemas/CraReportGetBaseReportResponseProduct",
"allOf": [
"cra_cashflow_insights": "#/components/schemas/CraReportGetCashflowInsightsResponseProduct",
{
"cra_home_lending": "#/components/schemas/CraReportGetHomeLendingResponseProduct",
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
"cra_income_complete": "#/components/schemas/CraReportGetIncomeCompleteResponseProduct",
},
"cra_income_insights": "#/components/schemas/CraReportGetIncomeInsightsResponseProduct",
{
"cra_lend_score": "#/components/schemas/CraReportGetLendScoreResponseProduct",
"properties": {
"cra_lend_score_complete": "#/components/schemas/CraReportGetLendScoreCompleteResponseProduct",
"credit_account_type_count": {
"cra_network_insights": "#/components/schemas/CraReportGetNetworkInsightsResponseProduct",
"type": "integer"
"cra_qualify": "#/components/schemas/CraReportGetQualifyResponseProduct"
},
},
"depository_account_type_count": {
"propertyName": "product"
"type": "integer"
},
},
"oneOf": [
"most_recent_transaction_date": {
{
"format": "date",
"additionalProperties": true,
"nullable": true,
"properties": {
"type": "string"
"attributes": {
},
"additionalProperties": {},
"multiple_owner_account_count": {
"nullable": true,
"type": "integer"
"title": "CraReportGetProductAttributes",
},
"type": "object"
"oldest_transaction_date": {
},
"format": "date",
"errors": {
"nullable": true,
"items": {
"type": "string"
"$ref": "#/components/schemas/PlaidError"
},
},
"other_account_type_count": {
"type": "array"
"type": "integer"
},
},
"metadata": {
"primary_account_count": {
"additionalProperties": {},
"type": "integer"
"nullable": true,
}
"title": "CraReportGetProductMetadata",
},
"type": "object"
"required": [
},
"primary_account_count",
"product": {
"depository_account_type_count",
"enum": [
"credit_account_type_count",
"cra_qualify"
"other_account_type_count",
],
"multiple_owner_account_count",
"type": "string"
"oldest_transaction_date",
},
"most_recent_transaction_date"
"version": {
],
"$ref": "#/components/schemas/CraProductVersion"
"type": "object"
}
}
},
],
"required": [
"nullable": true,
"product",
"title": "CraReportGetIncomeInsightsMetadata",
"version",
"type": "object"
"metadata",
},
"attributes",
"product": {
"errors"
"enum": [
],
"cra_income_insights"
"title": "CraReportGetQualifyResponseProduct",
],
"type": "object"
"type": "string"
},
},
{
"version": {
"additionalProperties": true,
"$ref": "#/components/schemas/CraProductVersion"
"properties": {
}
"attributes": {
},
"$ref": "#/components/schemas/CraReportGetIncomeInsightsAttributes"
"required": [
},
"product",
"errors": {
"version",
"items": {
"metadata",
"$ref": "#/components/schemas/PlaidError"
"attributes",
},
"errors"
"type": "array"
],
},
"title": "CraReportGetIncomeInsightsResponseProduct",
"items": {
"type": "object"
"items": {
},
"$ref": "#/components/schemas/CraReportGetBaseItem"
{
},
"additionalProperties": true,
"type": "array"
"properties": {
},
"attributes": {
"metadata": {
"additionalProperties": true,
"additionalProperties": true,
"nullable": true,
"allOf": [
"properties": {
{
"income_by_categories": {
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
"items": {
},
"additionalProperties": true,
{
"properties": {
"properties": {
"categories": {
"credit_account_type_count": {
"items": {
"type": "integer"
"additionalProperties": true,
},
"properties": {
"depository_account_type_count": {
"current": {
"type": "integer"
"$ref": "#/components/schemas/CraCurrentModeledIncome"
},
},
"investment_account_type_count": {
"income_category": {
"type": "integer"
"$ref": "#/components/schemas/CraIncomeCategory"
},
}
"most_recent_transaction_date": {
},
"format": "date",
"required": [
"nullable": true,
"income_category",
"type": "string"
"current"
},
],
"multiple_owner_account_count": {
"title": "CraReportGetHomeLendingCategoryIncome",
"type": "integer"
"type": "object"
},
},
"oldest_transaction_date": {
"type": "array"
"format": "date",
},
"nullable": true,
"iso_currency_code": {
"type": "string"
"$ref": "#/components/schemas/CreditIsoCurrencyCode"
},
},
"other_account_type_count": {
"unofficial_currency_code": {
"type": "integer"
"$ref": "#/components/schemas/CreditUnofficialCurrencyCode"
},
}
"primary_account_count": {
},
"type": "integer"
"required": [
}
"iso_currency_code",
},
"unofficial_currency_code",
"required": [
"categories"
"primary_account_count",
],
"depository_account_type_count",
"title": "CraReportGetHomeLendingIncomeByCategories",
"credit_account_type_count",
"type": "object"
"investment_account_type_count",
},
"other_account_type_count",
"type": "array"
"multiple_owner_account_count",
},
"oldest_transaction_date",
"income_metrics": {
"most_recent_transaction_date"
"items": {
],
"additionalProperties": true,
"type": "object"
"properties": {
}
"current": {
],
"$ref": "#/components/schemas/CraCurrentModeledIncome"
"nullable": true,
},
"title": "CraReportGetIncomeInsightsMetadata",
"iso_currency_code": {
"type": "object"
"$ref": "#/components/schemas/CreditIsoCurrencyCode"
},
},
"product": {
"unofficial_currency_code": {
"enum": [
"$ref": "#/components/schemas/CreditUnofficialCurrencyCode"
"cra_income_insights"
}
],
},
"type": "string"
"required": [
},
"current",
"version": {
"iso_currency_code",
"$ref": "#/components/schemas/CraProductVersion"
"unofficial_currency_code"
}
],
},
"title": "CraReportGetHomeLendingIncomeMetrics",
"required": [
"type": "object"
"product",
},
"version",
"type": "array"
"metadata",
},
"attributes",
"income_sources": {
"items",
"additionalProperties": true,
"errors"
"nullable": true,
],
"properties": {
"title": "CraReportGetIncomeInsightsResponseProduct",
"income_providers": {
"type": "object"
"items": {
},
"$ref": "#/components/schemas/CraBankIncomeIncomeProvider"
{
},
"additionalProperties": true,
"type": "array"
"properties": {
},
"attributes": {
"income_stream_count": {
"additionalProperties": true,
"type": "integer"
"nullable": true,
}
"properties": {
},
"income_by_categories": {
"required": [
"items": {
"income_stream_count",
"additionalProperties": true,
"income_providers"
"properties": {
],
"categories": {
"title": "CraReportGetHomeLendingIncomeSources",
"items": {
"type": "object"
"additionalProperties": true,
},
"properties": {
"loan_payments_bnpl_count_90d": {
"current": {
"type": "integer"
"$ref": "#/components/schemas/CraCurrentModeledIncome"
},
},
"loan_payments_cash_advance_count_90d": {
"income_category": {
"type": "integer"
"$ref": "#/components/schemas/CraIncomeCategory"
},
}
"payment_behavior_nsf_late_fees_flag_90d": {
},
"type": "integer"
"required": [
}
"income_category",
},
"current"
"required": [
],
"income_metrics",
"title": "CraReportGetHomeLendingCategoryIncome",
"income_by_categories",
"type": "object"
"income_sources",
},
"loan_payments_cash_advance_count_90d",
"type": "array"
"loan_payments_bnpl_count_90d",
},
"payment_behavior_nsf_late_fees_flag_90d"
"iso_currency_code": {
],
"$ref": "#/components/schemas/CreditIsoCurrencyCode"
"title": "CraReportGetHomeLendingAttributes",
},
"type": "object"
"unofficial_currency_code": {
},
"$ref": "#/components/schemas/CreditUnofficialCurrencyCode"
"errors": {
}
"items": {
},
"$ref": "#/components/schemas/PlaidError"
"required": [
},
"iso_currency_code",
"type": "array"
"unofficial_currency_code",
},
"categories"
"metadata": {
],
"additionalProperties": true,
"title": "CraReportGetHomeLendingIncomeByCategories",
"allOf": [
"type": "object"
{
},
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
"type": "array"
}
},
],
"income_metrics": {
"nullable": true,
"items": {
"title": "CraReportGetHomeLendingMetadata",
"additionalProperties": true,
"type": "object"
"properties": {
},
"current": {
"product": {
"$ref": "#/components/schemas/CraCurrentModeledIncome"
"enum": [
},
"cra_home_lending"
"iso_currency_code": {
],
"$ref": "#/components/schemas/CreditIsoCurrencyCode"
"type": "string"
},
},
"unofficial_currency_code": {
"version": {
"$ref": "#/components/schemas/CreditUnofficialCurrencyCode"
"$ref": "#/components/schemas/CraProductVersion"
}
}
},
},
"required": [
"required": [
"current",
"product",
"iso_currency_code",
"version",
"unofficial_currency_code"
"metadata",
],
"attributes",
"title": "CraReportGetHomeLendingIncomeMetrics",
"errors"
"type": "object"
],
},
"title": "CraReportGetHomeLendingResponseProduct",
"type": "array"
"type": "object"
},
}
"income_sources": {
],
"additionalProperties": true,
"title": "CraReportGetResponseProduct"
"nullable": true,
},
"properties": {
"type": "array"
"income_providers": {
},
"items": {
"retrieved_time": {
"$ref": "#/components/schemas/CraBankIncomeIncomeProvider"
"format": "date-time",
},
"type": "string"
"type": "array"
},
},
"scope": {
"income_stream_count": {
"$ref": "#/components/schemas/CraReportScope"
"type": "integer"
}
}
},
},
"required": [
"required": [
"retrieved_time",
"income_stream_count",
"scope",
"income_providers"
"decision_stage",
],
"consumer_report_permissible_purpose",
"title": "CraReportGetHomeLendingIncomeSources",
"products"
"type": "object"
],
},
"title": "CraReportGetReport",
"loan_payments_bnpl_count_90d": {
"type": "object"
"type": "integer"
},
},
"request_id": {
"loan_payments_cash_advance_count_90d": {
"$ref": "#/components/schemas/RequestID"
"type": "integer"
},
},
"user_id": {
"payment_behavior_nsf_late_fees_flag_90d": {
"$ref": "#/components/schemas/NewUserID"
"type": "integer"
},
}
"warnings": {
},
"items": {
"required": [
"$ref": "#/components/schemas/CheckReportWarning"
"income_metrics",
},
"income_by_categories",
"type": "array"
"income_sources",
}
"loan_payments_cash_advance_count_90d",
},
"loan_payments_bnpl_count_90d",
"required": [
"payment_behavior_nsf_late_fees_flag_90d"
],
"title": "CraReportGetHomeLendingAttributes",
"type": "object"
},
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"items": {
"items": {
"$ref": "#/components/schemas/CraReportGetEnrichedItem"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
}
],
"nullable": true,
"title": "CraReportGetHomeLendingMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_home_lending"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"attributes",
"items",
"errors"
],
"title": "CraReportGetHomeLendingResponseProduct",
"type": "object",
"x-hidden-from-docs": true
},
{
"additionalProperties": true,
"properties": {
"attributes": {
"$ref": "#/components/schemas/CraReportGetCashflowInsightsAttributes"
},
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
},
{
"properties": {
"credit_account_type_count": {
"type": "integer"
},
"depository_account_type_count": {
"type": "integer"
},
"investment_account_type_count": {
"type": "integer"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"multiple_owner_account_count": {
"type": "integer"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"other_account_type_count": {
"type": "integer"
},
"primary_account_count": {
"type": "integer"
}
},
"required": [
"primary_account_count",
"depository_account_type_count",
"credit_account_type_count",
"investment_account_type_count",
"other_account_type_count",
"multiple_owner_account_count",
"oldest_transaction_date",
"most_recent_transaction_date"
],
"type": "object"
}
],
"nullable": true,
"title": "CraReportGetCashflowInsightsMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_cashflow_insights"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"attributes",
"errors"
],
"title": "CraReportGetCashflowInsightsResponseProduct",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"attributes": {
"$ref": "#/components/schemas/CraReportGetNetworkInsightsAttributes"
},
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
},
{
"properties": {
"credit_account_type_count": {
"type": "integer"
},
"depository_account_type_count": {
"type": "integer"
},
"investment_account_type_count": {
"type": "integer"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"multiple_owner_account_count": {
"type": "integer"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"other_account_type_count": {
"type": "integer"
},
"primary_account_count": {
"type": "integer"
}
},
"required": [
"primary_account_count",
"depository_account_type_count",
"credit_account_type_count",
"investment_account_type_count",
"other_account_type_count",
"multiple_owner_account_count",
"oldest_transaction_date",
"most_recent_transaction_date"
],
"type": "object"
}
],
"nullable": true,
"title": "CraReportGetNetworkInsightsMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_network_insights"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"attributes",
"errors"
],
"title": "CraReportGetNetworkInsightsResponseProduct",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
},
{
"properties": {
"credit_account_type_count": {
"type": "integer"
},
"depository_account_type_count": {
"type": "integer"
},
"investment_account_type_count": {
"type": "integer"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"multiple_owner_account_count": {
"type": "integer"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"other_account_type_count": {
"type": "integer"
},
"primary_account_count": {
"type": "integer"
}
},
"required": [
"primary_account_count",
"depository_account_type_count",
"credit_account_type_count",
"investment_account_type_count",
"other_account_type_count",
"multiple_owner_account_count",
"oldest_transaction_date",
"most_recent_transaction_date"
],
"type": "object"
}
],
"nullable": true,
"title": "CraReportGetLendScoreMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_lend_score"
],
"type": "string"
},
"scores": {
"items": {
"$ref": "#/components/schemas/CraReportGetLendScoreVariantScore"
},
"type": "array"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"scores",
"errors"
],
"title": "CraReportGetLendScoreResponseProduct",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"attributes": {
"allOf": [
{
"additionalProperties": true,
"nullable": true,
"properties": {
"nsf_overdraft_transactions_count": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"nsf_overdraft_transactions_count_30d": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"nsf_overdraft_transactions_count_60d": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"nsf_overdraft_transactions_count_90d": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"total_inflow_amount": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportInflowAmount"
}
],
"x-hidden-from-docs": true
},
"total_inflow_amount_30d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportInflowAmount30d"
}
],
"x-hidden-from-docs": true
},
"total_inflow_amount_60d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportInflowAmount60d"
}
],
"x-hidden-from-docs": true
},
"total_inflow_amount_90d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportInflowAmount90d"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportOutflowAmount"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount_30d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportOutflowAmount30d"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount_60d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportOutflowAmount60d"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount_90d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalReportOutflowAmount90d"
}
],
"x-hidden-from-docs": true
}
},
"title": "CraReportGetBaseReportAttributes",
"type": "object",
"x-hidden-from-docs": true
}
],
"x-hidden-from-docs": true
},
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"items": {
"items": {
"additionalProperties": true,
"properties": {
"accounts": {
"items": {
"additionalProperties": true,
"properties": {
"account_id": {
"type": "string"
},
"account_insights": {
"allOf": [
{
"additionalProperties": true,
"nullable": true,
"properties": {
"average_days_between_transactions": {
"format": "double",
"nullable": true,
"type": "number"
},
"average_inflow_amounts": {
"items": {
"$ref": "#/components/schemas/BaseReportAverageFlowInsights"
},
"type": "array"
},
"average_outflow_amounts": {
"items": {
"$ref": "#/components/schemas/BaseReportAverageFlowInsights"
},
"type": "array"
},
"longest_gaps_between_transactions": {
"items": {
"additionalProperties": true,
"properties": {
"days": {
"nullable": true,
"type": "integer"
},
"end_date": {
"format": "date",
"type": "string"
},
"start_date": {
"format": "date",
"type": "string"
}
},
"required": [
"start_date",
"end_date",
"days"
],
"title": "CraReportGetBaseReportLongestGapInsight",
"type": "object",
"x-hidden-from-docs": true
},
"type": "array"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"number_of_days_no_transactions": {
"type": "integer"
},
"number_of_inflows": {
"items": {
"$ref": "#/components/schemas/BaseReportNumberFlowInsights"
},
"type": "array"
},
"number_of_outflows": {
"items": {
"$ref": "#/components/schemas/BaseReportNumberFlowInsights"
},
"type": "array"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"oldest_transaction_date",
"most_recent_transaction_date",
"average_days_between_transactions",
"number_of_days_no_transactions",
"longest_gaps_between_transactions",
"number_of_inflows",
"number_of_outflows",
"average_inflow_amounts",
"average_outflow_amounts"
],
"title": "CraReportGetBaseReportAccountInsights",
"type": "object",
"x-hidden-from-docs": true
}
],
"x-hidden-from-docs": true
},
"attributes": {
"additionalProperties": true,
"nullable": true,
"properties": {
"is_primary_account": {
"nullable": true,
"type": "boolean"
},
"nsf_overdraft_transactions_count": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"nsf_overdraft_transactions_count_30d": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"nsf_overdraft_transactions_count_60d": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"nsf_overdraft_transactions_count_90d": {
"nullable": true,
"type": "integer",
"x-hidden-from-docs": true
},
"primary_account_score": {
"format": "double",
"nullable": true,
"type": "number"
},
"total_inflow_amount": {
"allOf": [
{
"$ref": "#/components/schemas/TotalInflowAmount"
}
],
"x-hidden-from-docs": true
},
"total_inflow_amount_30d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalInflowAmount30d"
}
],
"x-hidden-from-docs": true
},
"total_inflow_amount_60d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalInflowAmount60d"
}
],
"x-hidden-from-docs": true
},
"total_inflow_amount_90d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalInflowAmount90d"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount": {
"allOf": [
{
"$ref": "#/components/schemas/TotalOutflowAmount"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount_30d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalOutflowAmount30d"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount_60d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalOutflowAmount60d"
}
],
"x-hidden-from-docs": true
},
"total_outflow_amount_90d": {
"allOf": [
{
"$ref": "#/components/schemas/TotalOutflowAmount90d"
}
],
"x-hidden-from-docs": true
}
},
"required": [
"is_primary_account",
"primary_account_score"
],
"title": "CraReportGetBaseReportAccountAttributes",
"type": "object"
},
"balances": {
"additionalProperties": true,
"properties": {
"available": {
"format": "double",
"nullable": true,
"type": "number"
},
"average_balance": {
"format": "double",
"nullable": true,
"type": "number"
},
"average_monthly_balances": {
"items": {
"additionalProperties": true,
"properties": {
"average_balance": {
"$ref": "#/components/schemas/CreditAmountWithCurrency"
},
"end_date": {
"format": "date",
"type": "string"
},
"start_date": {
"format": "date",
"type": "string"
}
},
"required": [
"start_date",
"end_date",
"average_balance"
],
"title": "CraReportGetBaseReportAverageMonthlyBalance",
"type": "object"
},
"type": "array"
},
"current": {
"format": "double",
"nullable": true,
"type": "number"
},
"iso_currency_code": {
"$ref": "#/components/schemas/CreditIsoCurrencyCode"
},
"limit": {
"format": "double",
"nullable": true,
"type": "number"
},
"most_recent_thirty_day_average_balance": {
"format": "double",
"nullable": true,
"type": "number"
},
"unofficial_currency_code": {
"$ref": "#/components/schemas/CreditUnofficialCurrencyCode"
}
},
"required": [
"available",
"current",
"limit",
"iso_currency_code",
"unofficial_currency_code",
"average_balance",
"most_recent_thirty_day_average_balance",
"average_monthly_balances"
],
"title": "CraReportGetBaseReportAccountBalances",
"type": "object"
},
"consumer_disputes": {
"items": {
"$ref": "#/components/schemas/ConsumerDispute"
},
"type": "array"
},
"days_available": {
"type": "integer"
},
"historical_balances": {
"items": {
"$ref": "#/components/schemas/BaseReportHistoricalBalance"
},
"type": "array",
"x-hidden-from-docs": true
},
"identity_match": {
"additionalProperties": true,
"nullable": true,
"properties": {
"address": {
"$ref": "#/components/schemas/AddressMatchScore"
},
"email_address": {
"$ref": "#/components/schemas/EmailAddressMatchScore"
},
"legal_name": {
"$ref": "#/components/schemas/NameMatchScore"
},
"phone_number": {
"$ref": "#/components/schemas/PhoneNumberMatchScore"
}
},
"required": [
"legal_name",
"phone_number",
"email_address",
"address"
],
"title": "CraReportGetBaseReportAccountIdentityMatch",
"type": "object"
},
"mask": {
"nullable": true,
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/BaseReportAccountMetadata"
},
"name": {
"type": "string"
},
"official_name": {
"nullable": true,
"type": "string"
},
"owners": {
"items": {
"$ref": "#/components/schemas/Owner"
},
"type": "array"
},
"ownership_type": {
"$ref": "#/components/schemas/OwnershipType"
},
"subtype": {
"$ref": "#/components/schemas/AccountSubtype"
},
"transactions": {
"items": {
"additionalProperties": true,
"properties": {
"account_id": {
"type": "string"
},
"account_owner": {
"nullable": true,
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"category": {
"items": {
"type": "string"
},
"type": "array",
"x-hidden-from-docs": true
},
"category_id": {
"nullable": true,
"type": "string",
"x-hidden-from-docs": true
},
"check_number": {
"nullable": true,
"type": "string"
},
"credit_category": {
"$ref": "#/components/schemas/CreditCategory"
},
"date": {
"format": "date",
"type": "string"
},
"date_transacted": {
"format": "date",
"nullable": true,
"type": "string"
},
"iso_currency_code": {
"$ref": "#/components/schemas/CreditIsoCurrencyCode"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"merchant_name": {
"nullable": true,
"type": "string"
},
"name": {
"deprecated": true,
"nullable": true,
"type": "string",
"x-hidden-from-docs": true
},
"original_description": {
"nullable": true,
"type": "string"
},
"pending": {
"type": "boolean"
},
"personal_finance_category": {
"allOf": [
{
"$ref": "#/components/schemas/PersonalFinanceCategory"
}
],
"x-hidden-from-docs": true
},
"transaction_id": {
"type": "string"
},
"unofficial_currency_code": {
"$ref": "#/components/schemas/CreditUnofficialCurrencyCode"
}
},
"required": [
"transaction_id",
"account_id",
"amount",
"iso_currency_code",
"unofficial_currency_code",
"original_description",
"merchant_name",
"credit_category",
"check_number",
"date",
"date_transacted",
"pending",
"account_owner",
"location"
],
"title": "CraReportGetBaseReportTransaction",
"type": "object"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/AccountType"
}
},
"required": [
"account_id",
"name",
"official_name",
"mask",
"type",
"subtype",
"days_available",
"metadata",
"balances",
"owners",
"ownership_type",
"consumer_disputes",
"transactions",
"attributes"
],
"title": "CraReportGetBaseReportAccount",
"type": "object"
},
"type": "array"
},
"date_last_updated": {
"format": "date-time",
"type": "string"
},
"institution_id": {
"type": "string"
},
"institution_name": {
"type": "string"
},
"item_id": {
"$ref": "#/components/schemas/ItemId"
}
},
"required": [
"item_id",
"institution_id",
"institution_name",
"date_last_updated",
"accounts"
],
"title": "CraReportGetBaseReportItem",
"type": "object"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
},
{
"properties": {
"credit_account_type_count": {
"type": "integer"
},
"days_requested": {
"type": "integer"
},
"depository_account_type_count": {
"type": "integer"
},
"investment_account_type_count": {
"type": "integer"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"multiple_owner_account_count": {
"type": "integer"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"other_account_type_count": {
"type": "integer"
},
"primary_account_count": {
"type": "integer"
}
},
"required": [
"days_requested",
"primary_account_count",
"depository_account_type_count",
"credit_account_type_count",
"investment_account_type_count",
"other_account_type_count",
"multiple_owner_account_count",
"oldest_transaction_date",
"most_recent_transaction_date"
],
"type": "object"
}
],
"nullable": true,
"title": "CraReportGetBaseReportMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_base_report"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"items",
"errors"
],
"title": "CraReportGetBaseReportResponseProduct",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"attributes": {
"additionalProperties": true,
"nullable": true,
"properties": {
"cashflow_insights": {
"$ref": "#/components/schemas/CraReportGetCashflowInsightsAttributes"
},
"lend_scores": {
"items": {
"$ref": "#/components/schemas/CraReportGetLendScoreVariantScore"
},
"type": "array"
},
"network_insights": {
"$ref": "#/components/schemas/CraReportGetNetworkInsightsAttributes"
}
},
"required": [
"lend_scores",
"cashflow_insights",
"network_insights"
],
"title": "CraReportGetLendScoreCompleteAttributes",
"type": "object"
},
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"items": {
"items": {
"$ref": "#/components/schemas/CraReportGetEnrichedItem"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
},
{
"properties": {
"credit_account_type_count": {
"type": "integer"
},
"depository_account_type_count": {
"type": "integer"
},
"investment_account_type_count": {
"type": "integer"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"multiple_owner_account_count": {
"type": "integer"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"other_account_type_count": {
"type": "integer"
},
"primary_account_count": {
"type": "integer"
}
},
"required": [
"primary_account_count",
"depository_account_type_count",
"credit_account_type_count",
"investment_account_type_count",
"other_account_type_count",
"multiple_owner_account_count",
"oldest_transaction_date",
"most_recent_transaction_date"
],
"type": "object"
}
],
"nullable": true,
"title": "CraReportGetLendScoreCompleteMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_lend_score_complete"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"attributes",
"items",
"errors"
],
"title": "CraReportGetLendScoreCompleteResponseProduct",
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"attributes": {
"additionalProperties": true,
"nullable": true,
"properties": {
"income_insights": {
"$ref": "#/components/schemas/CraReportGetIncomeInsightsAttributes"
}
},
"required": [
"income_insights"
],
"title": "CraReportGetIncomeCompleteAttributes",
"type": "object"
},
"errors": {
"items": {
"$ref": "#/components/schemas/PlaidError"
},
"type": "array"
},
"items": {
"items": {
"$ref": "#/components/schemas/CraReportGetEnrichedItem"
},
"type": "array"
},
"metadata": {
"additionalProperties": true,
"allOf": [
{
"$ref": "#/components/schemas/CraReportGetProductBaseMetadata"
},
{
"properties": {
"credit_account_type_count": {
"type": "integer"
},
"depository_account_type_count": {
"type": "integer"
},
"investment_account_type_count": {
"type": "integer"
},
"most_recent_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"multiple_owner_account_count": {
"type": "integer"
},
"oldest_transaction_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"other_account_type_count": {
"type": "integer"
},
"primary_account_count": {
"type": "integer"
}
},
"required": [
"primary_account_count",
"depository_account_type_count",
"credit_account_type_count",
"investment_account_type_count",
"other_account_type_count",
"multiple_owner_account_count",
"oldest_transaction_date",
"most_recent_transaction_date"
],
"type": "object"
}
],
"nullable": true,
"title": "CraReportGetIncomeCompleteMetadata",
"type": "object"
},
"product": {
"enum": [
"cra_income_complete"
],
"type": "string"
},
"version": {
"$ref": "#/components/schemas/CraProductVersion"
}
},
"required": [
"product",
"version",
"metadata",
"attributes",
"items",
"errors"
],
"title": "CraReportGetIncomeCompleteResponseProduct",
"type": "object"
}
],
"title": "CraReportGetResponseProduct"
},
"type": "array"
},
"report_id": {
"allOf": [
{
"$ref": "#/components/schemas/CraReportId"
},
{}
],
"nullable": true
},
"retrieved_time": {
"format": "date-time",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/CraReportScope"
}
},
"required": [
"report_id",
"client_report_id",
"retrieved_time",
"scope",
"decision_stage",
"consumer_report_permissible_purpose",
"products"
],
"title": "CraReportGetReport",
"type": "object"
},
"request_id": {
"$ref": "#/components/schemas/RequestID"
},
"user_id": {
"$ref": "#/components/schemas/NewUserID"
},
"warnings": {
"items": {
"$ref": "#/components/schemas/CheckReportWarning"
},
"type": "array"
}
},
"required": [
"client_user_id",
"report",
"report",
"request_id",
"request_id",
"user_id",
"user_id",

Monitored for you

Does this change affect your integration?

Choose the operations and fields your services use. Detektu matches Plaid findings to that declared usage so your team can review the relevant evidence. No agent or repository access required.

Monitor Plaid free See pricing