---
updatedAt: 2026-05-27T02:51:28.000Z
agentTools:
  projectIndex: https://developers.bloomcredit.io/llms.txt
---

# Get Accounts Paginated

Returns a paginated collection of furnished accounts for the authenticated organization. Results can be filtered by account ID, external account identifier, credit product ID, creation date range, opened date, or reported consumer account number.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Account": {
        "description": "An account response",
        "properties": {
          "account_opened_date": {
            "format": "date",
            "title": "Account Opened Date",
            "type": "string",
            "description": "Date on which the account was opened.",
            "example": "2024-01-31"
          },
          "bankruptcy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BankruptcyEvent"
              }
            ],
            "description": "Active consumer bankruptcy affecting this account, when one exists."
          },
          "business_address": {
            "title": "Business Address",
            "type": "string",
            "description": "Street address of the business responsible for a commercial account.",
            "example": "100 Business Blvd"
          },
          "business_ein": {
            "title": "Business Ein",
            "type": "string",
            "description": "Employer Identification Number of the business responsible for a commercial account.",
            "example": "912345678"
          },
          "business_name": {
            "title": "Business Name",
            "type": "string",
            "description": "Legal name of the business responsible for a commercial account.",
            "example": "Acme Corp"
          },
          "business_phone_number": {
            "title": "Business Phone Number",
            "type": "string",
            "description": "Contact phone number of the business responsible for a commercial account.",
            "example": "1234567890"
          },
          "charge_off": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ChargeOff"
              }
            ],
            "description": "Active charge-off event for the account, when one exists."
          },
          "collateral": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Collateral"
              }
            ],
            "description": "Active collateral event for the account, when one exists."
          },
          "collections": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Collections"
              }
            ],
            "description": "Active collections event for the account, when one exists."
          },
          "consumer_attested_terms_frequency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TermsFrequency"
              }
            ],
            "description": "Payment frequency attested by the consumer, when the account was sourced from consumer-permissioned data."
          },
          "credit_product_id": {
            "format": "uuid",
            "title": "Credit Product Id",
            "type": "string",
            "description": "Unique identifier of the credit product whose reporting rules apply.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "date_of_first_delinquency": {
            "format": "date",
            "title": "Date Of First Delinquency",
            "type": "string",
            "description": "Date when the continuous delinquency that led to the current status began.",
            "example": "2024-01-31"
          },
          "deleted": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountDeleteEvent"
              }
            ],
            "description": "Active deletion event for the account, when the account has been soft-deleted."
          },
          "disputes": {
            "default": [],
            "items": {
              "$ref": "#/components/schemas/Dispute"
            },
            "title": "Disputes",
            "type": "array",
            "description": "Active dispute events, at most one per dispute source (FCRA, FCBA, FDCPA)."
          },
          "external_account_identifier": {
            "title": "External Account Identifier",
            "type": "string",
            "description": "Partner-supplied identifier used to correlate the account with an external system.",
            "example": "ac69b78e-62c9-11ee-8c99-0242ac120002"
          },
          "forbearance": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Forbearance"
              }
            ],
            "description": "Active forbearance event for the account, when one exists."
          },
          "foreclosure": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Foreclosure"
              }
            ],
            "description": "Active foreclosure event for the account, when one exists."
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "lien": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Lien"
              }
            ],
            "description": "Active lien event for the account, when one exists."
          },
          "natural_disaster": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NaturalDisaster"
              }
            ],
            "description": "Active natural-disaster event for the account, when one exists."
          },
          "original_creditor_classification": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreditorClassificationCode"
              }
            ],
            "description": "Metro 2 creditor classification of the original creditor, reported for purchased or collection accounts."
          },
          "original_creditor_name": {
            "title": "Original Creditor Name",
            "type": "string",
            "description": "Name of the original creditor, reported for purchased or collection accounts.",
            "example": "Original Bank NA"
          },
          "paid_off": {
            "default": false,
            "title": "Paid Off",
            "type": "boolean",
            "description": "Whether the account has been paid off.",
            "example": false
          },
          "payment_default": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentDefaultEvent"
              }
            ],
            "description": "Active first-payment-default event for the account, when one exists."
          },
          "positions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/app__schemas__v1__account__account_position__response__AccountPosition"
              }
            ],
            "description": "Active account-position event (closure or credit-line suspension), when one exists."
          },
          "primary_consumer_id": {
            "format": "uuid",
            "title": "Primary Consumer Id",
            "type": "string",
            "description": "Unique identifier of the consumer primarily responsible for the account.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "primary_designation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ECOACode"
              }
            ],
            "description": "ECOA designation describing the primary consumer's responsibility for the account."
          },
          "refinance_modification": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RefinanceModification"
              }
            ],
            "description": "Active refinance-modification event for the account, when one exists. When present, `terms_duration` reflects the modified term."
          },
          "reported_consumer_account_number": {
            "title": "Reported Consumer Account Number",
            "type": "string",
            "description": "Account number reported to the credit bureaus; the service may mask it in responses.",
            "example": "123433578"
          },
          "secondary_consumer_events": {
            "default": [],
            "items": {
              "$ref": "#/components/schemas/SecondaryConsumerEvent"
            },
            "title": "Secondary Consumer Events",
            "type": "array",
            "description": "Secondary-consumer add and remove events recorded against the account."
          },
          "secondary_consumers": {
            "default": [],
            "items": {
              "$ref": "#/components/schemas/SecondaryConsumerInfo"
            },
            "title": "Secondary Consumers",
            "type": "array",
            "description": "Secondary consumers and their reporting designations for this account."
          },
          "secondary_market_or_mers": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SecondaryMarket"
              }
            ],
            "description": "Secondary-market owner or MERS designation for a mortgage account."
          },
          "secondary_market_or_mers_number": {
            "title": "Secondary Market Or Mers Number",
            "type": "string",
            "description": "Identifier assigned by the secondary-market owner or MERS.",
            "example": "100123456789012345"
          },
          "terms_duration": {
            "title": "Terms Duration",
            "type": "string",
            "description": "Contract term encoded for Metro 2 reporting, such as a three-digit month count or `REV`/`LOC`.",
            "example": "012"
          },
          "transfer": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Transfer"
              }
            ],
            "description": "Active transfer event for the account, when one exists."
          }
        },
        "required": [
          "credit_product_id",
          "account_opened_date",
          "terms_duration",
          "id",
          "external_account_identifier",
          "reported_consumer_account_number"
        ],
        "title": "Account",
        "type": "object"
      },
      "AccountClosedInitiator": {
        "description": "An enumeration.",
        "enum": [
          "CREDITOR",
          "CONSUMER"
        ],
        "title": "AccountClosedInitiator"
      },
      "AccountDeleteEvent": {
        "properties": {
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "deleted_notes": {
            "title": "Deleted Notes",
            "type": "string",
            "description": "Free-form note explaining why the account was deleted.",
            "example": "Deleted at consumer request."
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "external_delete_date": {
            "format": "date",
            "title": "External Delete Date",
            "type": "string",
            "description": "Date the partner recorded the deletion in its own system.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountDeletionReason"
              }
            ],
            "description": "Reason the account was deleted."
          }
        },
        "title": "AccountDeleteEvent",
        "type": "object",
        "description": "Active deletion event recorded against an account."
      },
      "AccountDeletionReason": {
        "description": "An enumeration.",
        "enum": [
          "CONFIRMED_FRAUD",
          "OTHER_REASON_NOT_FRAUD"
        ],
        "title": "AccountDeletionReason"
      },
      "AccountResponsePaginated": {
        "description": "A page of account resources together with the paging metadata.",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/Account"
            },
            "title": "Data",
            "type": "array",
            "description": "Accounts on the requested page."
          },
          "id": {
            "title": "Id",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "page": {
            "title": "Page",
            "type": "integer",
            "description": "One-based result page to return.",
            "example": 1
          },
          "total": {
            "title": "Total",
            "type": "integer",
            "description": "Total number of matching resources.",
            "example": 42
          }
        },
        "required": [
          "page",
          "total",
          "data"
        ],
        "title": "AccountResponsePaginated",
        "type": "object"
      },
      "BankruptcyChapter": {
        "description": "An enumeration.",
        "enum": [
          "CHAPTER_7",
          "CHAPTER_11",
          "CHAPTER_12",
          "CHAPTER_13"
        ],
        "title": "BankruptcyChapter",
        "type": "string"
      },
      "BankruptcyEvent": {
        "properties": {
          "chapter": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BankruptcyChapter"
              }
            ],
            "description": "Bankruptcy chapter under which the case was filed."
          },
          "consumer_id": {
            "format": "uuid",
            "title": "Consumer Id",
            "type": "string",
            "description": "Unique identifier of the consumer.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this request reverses the corresponding active event.",
            "example": false
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BankruptcyStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "BankruptcyEvent",
        "type": "object",
        "description": "Represents bankruptcy event."
      },
      "BankruptcyStatus": {
        "description": "An enumeration.",
        "enum": [
          "FILED",
          "REMOVAL",
          "DISCHARGED",
          "REAFFIRMED",
          "RESCINDED",
          "CONFIRMED"
        ],
        "title": "BankruptcyStatus",
        "type": "string"
      },
      "ChargeOff": {
        "properties": {
          "amount": {
            "minimum": 0,
            "title": "Amount",
            "type": "number",
            "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.",
            "example": 100
          },
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ChargeOffSpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ChargeOffStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "ChargeOff",
        "type": "object",
        "description": "Represents charge off."
      },
      "ChargeOffSpecialCommentCode": {
        "description": "An enumeration.",
        "enum": [
          "CHARGE_OFF",
          "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE",
          "CREDIT_LINE_SUSPENDED"
        ],
        "title": "ChargeOffSpecialCommentCode",
        "type": "string"
      },
      "ChargeOffStatus": {
        "description": "An enumeration.",
        "enum": [
          "CHARGE_OFF",
          "PAID_IN_FULL_CHARGE_OFF",
          "UNPAID_BALANCE_REPORTED_AS_LOSS"
        ],
        "title": "ChargeOffStatus",
        "type": "string"
      },
      "Collateral": {
        "properties": {
          "amount": {
            "minimum": 0,
            "title": "Amount",
            "type": "number",
            "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.",
            "example": 100
          },
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CollateralSpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CollateralStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "Collateral",
        "type": "object",
        "description": "Represents collateral."
      },
      "CollateralSpecialCommentCode": {
        "description": "An enumeration.",
        "enum": [
          "VOLUNTARY_SURRENDERED",
          "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE",
          "CREDIT_LINE_SUSPENDED",
          "CREDIT_LINE_REDUCED_DUE_TO_COLLATERAL_DEPRECIATION",
          "CREDIT_LINE_SUSPENDED_DUE_TO_COLLATERAL_DEPRECIATION",
          "COLLATERAL_RELEASED_BY_CREDITOR",
          "VOLUNTARY_SURRENDERED_REDEEMED_REINSTATED",
          "REPOSSESSION_REDEEMED_REINSTATED"
        ],
        "title": "CollateralSpecialCommentCode",
        "type": "string"
      },
      "CollateralStatus": {
        "description": "An enumeration.",
        "enum": [
          "VOLUNTARY_SURRENDERED",
          "PAID_IN_FULL_FORECLOSURE_WAS_STARTED",
          "DEED_RECEIVED_IN_LIEU_OF_FORECLOSURE_ON_DEFAULTED_MORTGAGE",
          "REPOSSESSION",
          "COLLATERAL_DEPRECIATION",
          "COLLATERAL_RELEASED",
          "SHORT_SALE",
          "LOAN"
        ],
        "title": "CollateralStatus",
        "type": "string"
      },
      "Collections": {
        "properties": {
          "amount": {
            "minimum": 0,
            "title": "Amount",
            "type": "number",
            "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.",
            "example": 100
          },
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CollectionsSpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CollectionsStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "Collections",
        "type": "object",
        "description": "Represents collections."
      },
      "CollectionsSpecialCommentCode": {
        "description": "An enumeration.",
        "enum": [
          "COLLECTIONS",
          "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE",
          "CREDIT_LINE_SUSPENDED"
        ],
        "title": "CollectionsSpecialCommentCode",
        "type": "string"
      },
      "CollectionsStatus": {
        "description": "An enumeration.",
        "enum": [
          "PAID_IN_FULL_COLLECTION_ACCOUNT"
        ],
        "title": "CollectionsStatus",
        "type": "string"
      },
      "CreditorClassificationCode": {
        "description": "The Metro2 K1 segment field \"Creditor Classification\"",
        "enum": [
          "RETAIL",
          "MEDICAL_HEALTH_CARE",
          "OIL_COMPANY",
          "GOVERNMENT",
          "PERSONAL_SERVICES",
          "INSURANCE",
          "EDUCATIONAL",
          "BANKING",
          "RENTAL_LEASING",
          "UTILITIES",
          "CABLE_CELLULAR",
          "FINANCIAL",
          "CREDIT_UNION",
          "AUTOMOTIVE",
          "CHECK_GUARANTEE"
        ],
        "title": "CreditorClassificationCode",
        "type": "string"
      },
      "Dispute": {
        "properties": {
          "consumer_disagreed": {
            "title": "Consumer Disagreed",
            "type": "boolean",
            "description": "Whether consumer disagreed applies.",
            "example": false
          },
          "effective_date": {
            "format": "date-time",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31T15:04:05Z"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reversed": {
            "title": "Reversed",
            "type": "boolean",
            "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.",
            "example": false
          },
          "reversed_on": {
            "format": "date-time",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "source": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DisputeSource"
              }
            ],
            "description": "Source associated with this resource."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DisputeStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "Dispute",
        "type": "object",
        "description": "Represents dispute."
      },
      "DisputeSource": {
        "description": "An enumeration.",
        "enum": [
          "FCRA",
          "FCBA",
          "FDCPA"
        ],
        "title": "DisputeSource"
      },
      "DisputeStatus": {
        "description": "An enumeration.",
        "enum": [
          "DISPUTE_STARTED",
          "DISPUTE_COMPLETED"
        ],
        "title": "DisputeStatus"
      },
      "ECOACode": {
        "description": "The ECOA Code defines the relationship of the consumer to the account in compliance\nwith the Equal Credit Opportunity Act.\n\nAttributes:\n- `INDIVIDUAL`: This consumer has contractual responsibility for this account and         is primarily responsible for its payment.\n- `JOINT_CONTRACTUAL_LIABILITY`: This consumer has contractual responsibility for         this joint account.\n- `AUTHORIZED_USER`: This consumer is an authorized user of this account; another         consumer has contractual responsibility.\n- `COMAKER_OR_GUARANTOR`: This consumer is the co-maker or guarantor for this         account, who becomes liable if the maker defaults.\n- `MAKER`: This consumer is the maker who is liable for the account, but a        co-maker or guarantor is liable if the maker defaults.\n- `BUSINESS_COMMERCIAL`: This code is used to identify that the company reported        in the Name field is contractually liable for this account.\n- `DECEASED`: This consumer is deceased.\n- `TERMINATED`: The association with the account has been         terminated by this consumer.\n- `DELETE_CONSUMER`: This code is used to delete this consumer from the account.",
        "enum": [
          "INDIVIDUAL",
          "JOINT_CONTRACTUAL_LIABILITY",
          "AUTHORIZED_USER",
          "COMAKER_OR_GUARANTOR",
          "MAKER",
          "BUSINESS_COMMERCIAL",
          "DECEASED",
          "TERMINATED",
          "DELETE_CONSUMER"
        ],
        "title": "ECOACode",
        "type": "string"
      },
      "Forbearance": {
        "properties": {
          "amount": {
            "minimum": 0,
            "title": "Amount",
            "type": "number",
            "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.",
            "example": 100
          },
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ForbearanceSpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ForbearanceStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "Forbearance",
        "type": "object",
        "description": "Represents forbearance."
      },
      "ForbearanceSpecialCommentCode": {
        "description": "An enumeration.",
        "enum": [
          "ACCOUNT_IN_FORBEARANCE"
        ],
        "title": "ForbearanceSpecialCommentCode",
        "type": "string"
      },
      "ForbearanceStatus": {
        "description": "An enumeration.",
        "enum": [
          "FORBEARANCE"
        ],
        "title": "ForbearanceStatus",
        "type": "string"
      },
      "Foreclosure": {
        "properties": {
          "effective_date": {
            "format": "date-time",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31T15:04:05Z"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reversed": {
            "title": "Reversed",
            "type": "boolean",
            "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.",
            "example": false
          },
          "reversed_on": {
            "format": "date-time",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ForeclosureStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "Foreclosure",
        "type": "object",
        "description": "Represents foreclosure."
      },
      "ForeclosureStatus": {
        "description": "An enumeration.",
        "enum": [
          "FORECLOSURE_STARTED",
          "FORECLOSURE_COMPLETED"
        ],
        "title": "ForeclosureStatus"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ValidationError"
                }
              ],
              "description": "Human-readable detail explaining the result or error."
            },
            "title": "Detail",
            "type": "array",
            "description": "Human-readable detail explaining the result or error."
          }
        },
        "title": "HTTPValidationError",
        "type": "object",
        "description": "Error representation used when a request cannot be completed (httpvalidation error)."
      },
      "Lien": {
        "properties": {
          "amount": {
            "minimum": 0,
            "title": "Amount",
            "type": "number",
            "description": "Monetary amount associated with this event, expressed in dollars. Minimum: 0.",
            "example": 100
          },
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LienSpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LienStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "Lien",
        "type": "object",
        "description": "Represents lien."
      },
      "LienSpecialCommentCode": {
        "description": "An enumeration.",
        "enum": [
          "GOVERNMENT_CLAIM_FILED",
          "CREDIT_LINE_SUSPENDED"
        ],
        "title": "LienSpecialCommentCode",
        "type": "string"
      },
      "LienStatus": {
        "description": "An enumeration.",
        "enum": [
          "CLAIM_FILED_WITH_GOVT_FOR_INSURED_PORTION_ON_DEFAULTED_LOAN"
        ],
        "title": "LienStatus",
        "type": "string"
      },
      "LinkHref": {
        "properties": {
          "href": {
            "title": "Href",
            "type": "string",
            "description": "Href associated with this resource.",
            "example": "href"
          },
          "meta": {
            "title": "Meta",
            "type": "object",
            "description": "Metadata associated with the response."
          }
        },
        "required": [
          "href",
          "meta"
        ],
        "title": "LinkHref",
        "type": "object",
        "description": "Represents link href."
      },
      "NaturalDisaster": {
        "properties": {
          "effective_date": {
            "format": "date-time",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31T15:04:05Z"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reversed": {
            "title": "Reversed",
            "type": "boolean",
            "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.",
            "example": false
          },
          "reversed_on": {
            "format": "date-time",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NaturalDisasterStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "NaturalDisaster",
        "type": "object",
        "description": "Represents natural disaster."
      },
      "NaturalDisasterStatus": {
        "description": "An enumeration.",
        "enum": [
          "NATURAL_DISASTER_START",
          "NATURAL_DISASTER_END"
        ],
        "title": "NaturalDisasterStatus"
      },
      "PaymentDefaultEvent": {
        "properties": {
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentDefaultSpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PaymentDefaultStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "PaymentDefaultEvent",
        "type": "object",
        "description": "Represents payment default event."
      },
      "PaymentDefaultSpecialCommentCode": {
        "description": "Metro 2 special comment code reported for a first-payment default.",
        "enum": [
          "FIRST_PAYMENT_NEVER_RECEIVED"
        ],
        "title": "PaymentDefaultSpecialCommentCode",
        "type": "string"
      },
      "PaymentDefaultStatus": {
        "description": "Status to perform the reverse operation",
        "enum": [
          "FIRST_PAYMENT_NEVER_RECEIVED"
        ],
        "title": "PaymentDefaultStatus",
        "type": "string"
      },
      "RefinanceModification": {
        "description": "Active refinance or loan-modification event recorded against an account.",
        "properties": {
          "account_number": {
            "title": "Account Number",
            "type": "string",
            "description": "New reported account number established by the modification, when one was supplied.",
            "example": "123433578"
          },
          "effective_date": {
            "format": "date-time",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31T15:04:05Z"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reversed": {
            "title": "Reversed",
            "type": "boolean",
            "description": "Whether the event has been reversed as of today.",
            "example": false
          },
          "reversed_on": {
            "format": "date-time",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "skip_account_number_reversal": {
            "title": "Skip Account Number Reversal",
            "type": "boolean",
            "description": "Whether reversing this event leaves the reported account number in place.",
            "example": false
          },
          "terms_duration": {
            "title": "Terms Duration",
            "type": "string",
            "description": "Contract term established by the modification. This value overrides the account's `terms_duration` while the event is active.",
            "example": "024"
          }
        },
        "title": "RefinanceModification",
        "type": "object"
      },
      "ResourceIdentifier": {
        "description": "https://jsonapi.org/format/#document-resource-identifier-objects",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "meta": {
            "title": "Meta",
            "type": "object",
            "description": "Metadata associated with the response."
          },
          "type": {
            "title": "Type",
            "type": "string",
            "description": "API resource type.",
            "example": "type"
          }
        },
        "required": [
          "id",
          "type"
        ],
        "title": "ResourceIdentifier",
        "type": "object"
      },
      "ResponseData_AccountsPaginated_": {
        "description": "Represents response data accounts paginated.",
        "properties": {
          "attributes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountResponsePaginated"
              }
            ],
            "default": {},
            "title": "Attributes",
            "description": "Domain attributes for this resource."
          },
          "id": {
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "links": {
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "description": "Links value associated with this resource.",
                  "example": "links-value"
                },
                {
                  "$ref": "#/components/schemas/LinkHref"
                }
              ],
              "description": "Links value associated with this resource."
            },
            "title": "Links",
            "type": "object",
            "description": "Links related to this resource or collection."
          },
          "relationships": {
            "additionalProperties": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ResponseRelationshipModel"
                }
              ],
              "description": "Relationships value associated with this resource."
            },
            "title": "Relationships",
            "type": "object",
            "description": "API relationships to associated resources."
          },
          "type": {
            "enum": [
              "AccountsPaginated"
            ],
            "title": "Type",
            "type": "string",
            "description": "API resource type. Allowed values: `AccountsPaginated`.",
            "example": "AccountsPaginated"
          }
        },
        "required": [
          "id",
          "type"
        ],
        "title": "ResponseData[AccountsPaginated]",
        "type": "object"
      },
      "ResponseRelationshipModel": {
        "properties": {
          "data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ResourceIdentifier"
              },
              {
                "items": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResourceIdentifier"
                    }
                  ],
                  "description": "Primary API resource payload."
                },
                "type": "array",
                "description": "Primary API resource payload."
              }
            ],
            "title": "Data",
            "description": "Primary API resource payload."
          },
          "links": {
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "description": "Links value associated with this resource.",
                  "example": "links-value"
                },
                {
                  "$ref": "#/components/schemas/LinkHref"
                }
              ],
              "description": "Links value associated with this resource."
            },
            "title": "Links",
            "type": "object",
            "description": "Links related to this resource or collection."
          },
          "meta": {
            "title": "Meta",
            "type": "object",
            "description": "Metadata associated with the response."
          }
        },
        "title": "ResponseRelationshipModel",
        "type": "object",
        "description": "Represents response relationship model."
      },
      "Response_AccountsPaginated_": {
        "description": "Response envelope for accounts paginated.",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseData_AccountsPaginated_"
              }
            ],
            "description": "Primary API resource payload."
          },
          "included": {
            "items": {
              "description": "Included associated with this resource."
            },
            "title": "Included",
            "type": "array",
            "description": "Collection of included."
          },
          "links": {
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "description": "Links value associated with this resource.",
                  "example": "links-value"
                },
                {
                  "$ref": "#/components/schemas/LinkHref"
                }
              ],
              "description": "Links value associated with this resource."
            },
            "title": "Links",
            "type": "object",
            "description": "Links related to this resource or collection."
          },
          "meta": {
            "title": "Meta",
            "type": "object",
            "description": "Metadata associated with the response."
          }
        },
        "required": [
          "data"
        ],
        "title": "Response[AccountsPaginated]",
        "type": "object"
      },
      "SecondaryConsumerEvent": {
        "properties": {
          "account_id": {
            "format": "uuid",
            "title": "Account Id",
            "type": "string",
            "description": "Unique identifier of the furnished account.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "effective_date": {
            "format": "date-time",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31T15:04:05Z"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "organization_id": {
            "format": "uuid",
            "title": "Organization Id",
            "type": "string",
            "description": "Unique identifier of the organization that owns the resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "removal_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SecondaryRemovalType"
              }
            ],
            "description": "Removal type associated with this resource."
          },
          "reversed": {
            "title": "Reversed",
            "type": "boolean",
            "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.",
            "example": false
          },
          "reversed_on": {
            "format": "date-time",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SecondaryStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "required": [
          "id",
          "organization_id",
          "account_id"
        ],
        "title": "SecondaryConsumerEvent",
        "type": "object",
        "description": "Represents secondary consumer event."
      },
      "SecondaryConsumerInfo": {
        "properties": {
          "address_id": {
            "format": "uuid",
            "title": "Address Id",
            "type": "string",
            "description": "Optional identifier of the consumer address to use for furnishing.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "consumer_id": {
            "format": "uuid",
            "title": "Consumer Id",
            "type": "string",
            "description": "Unique Consumer Hub identifier of the secondary consumer.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "designation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ECOACode"
              }
            ],
            "description": "ECOA code describing the secondary consumer’s responsibility for the account."
          }
        },
        "required": [
          "consumer_id",
          "designation"
        ],
        "title": "SecondaryConsumerInfo",
        "type": "object",
        "description": "Represents secondary consumer info."
      },
      "SecondaryMarket": {
        "description": "Secondary-market owner or MERS designation reported for a mortgage account.",
        "enum": [
          "FANNIE_MAE",
          "FREDDIE_MAC",
          "MERS"
        ],
        "title": "SecondaryMarket",
        "type": "string"
      },
      "SecondaryRemovalType": {
        "description": "An enumeration.",
        "enum": [
          "TERMINATED",
          "DELETE_CONSUMER"
        ],
        "title": "SecondaryRemovalType"
      },
      "SecondaryStatus": {
        "description": "An enumeration.",
        "enum": [
          "ADD_SECONDARY_CONSUMER",
          "REMOVE_SECONDARY_CONSUMER"
        ],
        "title": "SecondaryStatus"
      },
      "SpecialCommentCode": {
        "description": "An enumeration.",
        "enum": [
          "ACCOUNT_CLOSED_AT_CREDIT_GRANTORS_REQUEST",
          "VOLUNTARY_SURRENDERED",
          "ACCOUNT_CLOSED_DUE_TO_REFINANCE",
          "ACCOUNT_CLOSED_DUE_TO_TRANSFER",
          "REDEEMED_OR_REINSTATED_REPOSSESSION",
          "CREDIT_CARD_LOST_OR_STOLEN",
          "ACCOUNT_CLOSED_DUE_TO_INACTIVITY",
          "CREDIT_LINE_NO_LONGER_AVAILABLE",
          "ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE"
        ],
        "title": "SpecialCommentCode"
      },
      "TermsFrequency": {
        "description": "The frequency for payments due.",
        "enum": [
          "DEFERRED",
          "WEEKLY",
          "BIWEEKLY",
          "SEMIMONTHLY",
          "MONTHLY"
        ],
        "title": "TermsFrequency",
        "type": "string"
      },
      "Transfer": {
        "properties": {
          "effective_date": {
            "format": "date-time",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31T15:04:05Z"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "reversed": {
            "title": "Reversed",
            "type": "boolean",
            "description": "Whether the event has been reversed as of today. Null when the event has never been reversed.",
            "example": false
          },
          "reversed_on": {
            "format": "date-time",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TransferStatus"
              }
            ],
            "description": "Current lifecycle or processing status."
          },
          "transfer_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TransferType"
              }
            ],
            "description": "Transfer type associated with this resource."
          }
        },
        "title": "Transfer",
        "type": "object",
        "description": "Represents transfer."
      },
      "TransferStatus": {
        "description": "An enumeration.",
        "enum": [
          "TRANSFER",
          "REMOVE_TRANSFER"
        ],
        "title": "TransferStatus",
        "type": "string"
      },
      "TransferType": {
        "description": "An enumeration.",
        "enum": [
          "SELL",
          "BUY"
        ],
        "title": "TransferType",
        "type": "string"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "description": "Loc associated with this resource.",
                  "example": "loc"
                },
                {
                  "type": "integer",
                  "description": "Loc associated with this resource.",
                  "example": 0
                }
              ],
              "description": "Loc associated with this resource."
            },
            "title": "Location",
            "type": "array",
            "description": "Collection of loc."
          },
          "msg": {
            "title": "Message",
            "type": "string",
            "description": "Msg associated with this resource.",
            "example": "msg"
          },
          "type": {
            "title": "Error Type",
            "type": "string",
            "description": "API resource type.",
            "example": "type"
          }
        },
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError",
        "type": "object",
        "description": "Error representation used when a request cannot be completed (validation error)."
      },
      "app__schemas__v1__account__account_position__enums__AccountPosition": {
        "description": "Account Position events that represent position changes on an account\"",
        "enum": [
          "ACCOUNT_CLOSED",
          "CREDIT_LINE_SUSPENDED"
        ],
        "title": "AccountPosition"
      },
      "app__schemas__v1__account__account_position__response__AccountPosition": {
        "properties": {
          "created_at": {
            "format": "date",
            "title": "Created At",
            "type": "string",
            "description": "Date on which the event was recorded by the service.",
            "example": "2024-01-31"
          },
          "effective_date": {
            "format": "date",
            "title": "Effective Date",
            "type": "string",
            "description": "Date on which the event takes effect for furnishing and status calculations.",
            "example": "2024-01-31"
          },
          "id": {
            "format": "uuid",
            "title": "Id",
            "type": "string",
            "description": "Stable identifier for this resource.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          "initiator": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccountClosedInitiator"
              }
            ],
            "description": "Party that initiated the account action."
          },
          "initiator_reversed": {
            "title": "Initiator Reversed",
            "type": "boolean",
            "description": "Whether initiator reversed applies.",
            "example": false
          },
          "initiator_reversed_on": {
            "format": "date-time",
            "title": "Initiator Reversed On",
            "type": "string",
            "description": "Date on which the initiator designation was reversed.",
            "example": "2024-01-31T15:04:05Z"
          },
          "reverse": {
            "title": "Reverse",
            "type": "boolean",
            "description": "Whether this event reverses a previously reported event. Reported as `true` whenever `reversed_on` is set, and omitted otherwise.",
            "example": true
          },
          "reversed_on": {
            "format": "date",
            "title": "Reversed On",
            "type": "string",
            "description": "Date on which the previously reported event was reversed.",
            "example": "2024-01-31"
          },
          "special_comment_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SpecialCommentCode"
              }
            ],
            "description": "Metro 2 special comment code applied by this event."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/app__schemas__v1__account__account_position__enums__AccountPosition"
              }
            ],
            "description": "Current lifecycle or processing status."
          }
        },
        "title": "AccountPosition",
        "type": "object",
        "description": "Represents app schemas v1 account account position response account position."
      }
    },
    "securitySchemes": {
      "Oauth2ClientCredentials": {
        "flows": {
          "clientCredentials": {
            "scopes": {
              "furnishment:all": "Manage accounts."
            },
            "tokenUrl": "https://authn.bloomcredit.dev/oauth2/token"
          }
        },
        "type": "oauth2"
      }
    }
  },
  "info": {
    "description": "API Gateway for all public facing endpoints",
    "title": "KrakenD - API Gateway",
    "version": "2.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/v2/furnishment/accounts": {
      "get": {
        "operationId": "get_accounts_paginated_api_v1_accounts__get",
        "parameters": [
          {
            "in": "query",
            "name": "account-id",
            "required": false,
            "schema": {
              "format": "uuid",
              "title": "Account-Id",
              "type": "string",
              "description": "Unique identifier for the associated account id.",
              "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
            },
            "description": "Account id used to filter or control the request.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          {
            "in": "query",
            "name": "external-account-identifier",
            "required": false,
            "schema": {
              "title": "External-Account-Identifier",
              "type": "string",
              "description": "External account identifier associated with this resource.",
              "example": "external-account-identifier"
            },
            "description": "External account identifier used to filter or control the request.",
            "example": "external-account-identifier"
          },
          {
            "in": "query",
            "name": "credit-product-id",
            "required": false,
            "schema": {
              "format": "uuid",
              "title": "Credit-Product-Id",
              "type": "string",
              "description": "Unique identifier for the associated credit product id.",
              "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
            },
            "description": "Credit product id used to filter or control the request.",
            "example": "fd60d845-3b1d-4ea7-b2fc-436cddfe65c2"
          },
          {
            "in": "query",
            "name": "create-start-date",
            "required": false,
            "schema": {
              "format": "date",
              "title": "Create-Start-Date",
              "type": "string",
              "description": "Create start date associated with this resource.",
              "example": "2024-01-31"
            },
            "description": "Create start date used to filter or control the request.",
            "example": "2024-01-31"
          },
          {
            "in": "query",
            "name": "create-end-date",
            "required": false,
            "schema": {
              "format": "date",
              "title": "Create-End-Date",
              "type": "string",
              "description": "Create end date associated with this resource.",
              "example": "2024-01-31"
            },
            "description": "Create end date used to filter or control the request.",
            "example": "2024-01-31"
          },
          {
            "in": "query",
            "name": "opened-date",
            "required": false,
            "schema": {
              "format": "date",
              "title": "Opened-Date",
              "type": "string",
              "description": "Opened date associated with this resource.",
              "example": "2024-01-31"
            },
            "description": "Opened date used to filter or control the request.",
            "example": "2024-01-31"
          },
          {
            "in": "query",
            "name": "reported-consumer-account-number",
            "required": false,
            "schema": {
              "title": "Reported-Consumer-Account-Number",
              "type": "string",
              "description": "Account number reported to the credit bureaus.",
              "example": "123433578"
            },
            "description": "Reported consumer account number used to filter the request.",
            "example": "123433578"
          },
          {
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "default": 1,
              "minimum": 1,
              "title": "Page",
              "type": "integer",
              "description": "One-based result page to return.",
              "example": 1
            },
            "description": "One-based result page to return.",
            "example": 1
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 100,
              "minimum": 1,
              "title": "Limit",
              "type": "integer",
              "description": "Maximum number of resources to return per page.",
              "example": 25
            },
            "description": "Maximum number of resources to return per page.",
            "example": 25
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Response_AccountsPaginated_"
                }
              }
            },
            "description": "Successful Response"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "security": [
          {
            "Oauth2ClientCredentials": [
              "furnishment:all"
            ]
          }
        ],
        "summary": "Get Accounts Paginated",
        "tags": [
          "Accounts"
        ],
        "description": "Returns a paginated collection of furnished accounts for the authenticated organization. Results can be filtered by account ID, external account identifier, credit product ID, creation date range, opened date, or reported consumer account number."
      }
    }
  },
  "servers": [
    {
      "description": "Furnishment sandbox server, for testing purposes (v2)",
      "url": "https://sandbox.bloom.dev"
    },
    {
      "description": "Furnishment server",
      "url": "https://api.bloomcredit.io"
    },
    {
      "description": "Production Consumer Permissioned Data server",
      "url": "https://api.bloomplus.com"
    },
    {
      "description": "Development Consumer Permissioned Data server",
      "url": "https://api.bloomplus.dev"
    }
  ]
}
```