> For the complete documentation index, see [llms.txt](https://developers.bloomcredit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bloomcredit.io/reference/furnishment-api/account-events/create-account-event.md).

# Create Account Event

This is the single endpoint that captures every account lifecycle event. Each event is individually optional, but at least one must be provided; a request with no events is rejected. Each event has its own required attributes, and every event accepts `effective_date`, `reverse`, and `reversed_on` to record or reverse it.

Supported events:

* `add_secondary_consumers`: Add one or more secondary consumers to an account.
* `charge_off`: Report a charge-off. Either the unpaid balance is reported as a loss, or the account was paid in full after a charge-off. Reporting an unpaid balance as a loss requires the previous statement to be at least 30 days delinquent.
* `close`: Report that the account was closed, including which party initiated it.
* `collateral_depreciation`: Report that a credit line was reduced or suspended due to collateral depreciation. Intended for home equity and other secured lines of credit.
* `collections`: Report that the account was assigned to internal or external collections.
* `credit_line_suspended`: Report an account whose credit line has been suspended.
* `deed_received_mortgage`: Report a deed received in lieu of foreclosure on a mortgage.
* `delete`: Create a delete account event. This soft-deletes the account.
* `dispute_completed`: Report a dispute completed event for a dispute source.
* `dispute_started`: Report a dispute started event for a dispute source.
* `forbearance`: Report that the account entered forbearance.
* `foreclosure_completed`: Report a foreclosure completed event. A `foreclosure_started` event must already exist for the account.
* `foreclosure_started`: Report a foreclosure started event.
* `loan_redemption`: Report a loan redemption. A collateral event (voluntary surrender or repossession) must already exist.
* `loan_reinstatement`: Report a loan reinstatement. A collateral event (voluntary surrender or repossession) must already exist.
* `natural_disaster_end`: End a natural disaster accommodation. A matching `natural_disaster_start` event must already exist.
* `natural_disaster_start`: Report an account affected by a natural disaster.
* `refinance_modification`: Report a refinance or loan modification, including refinancing and renegotiation. Only allowed for mortgage portfolio types. If `account_number` is provided, an account number event is created automatically.
* `remove_secondary_consumers`: Remove one or more secondary consumers from an account.
* `remove_transfer`: Remove an existing transfer of the account.
* `repossession`: Report a repossession event.
* `short_sale`: Report a short sale event. The account must have a valid account status.
* `transfer`: Report a sell or buy transfer of the account.
* `voluntary_surrender`: Report that the consumer voluntarily surrendered collateral.

```json
{"openapi":"3.1.0","info":{"title":"Furnishment API","version":"2.0"},"tags":[{"name":"Account Events"}],"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"}],"security":[{"Oauth2ClientCredentials":["furnishment:all"]}],"components":{"securitySchemes":{"Oauth2ClientCredentials":{"flows":{"clientCredentials":{"scopes":{"furnishment:all":"Manage accounts."},"tokenUrl":"https://authn.bloomcredit.dev/oauth2/token"}},"type":"oauth2"}},"schemas":{"Request_AccountUpdateEvent_":{"description":"Request envelope for account update event.","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/RequestData_AccountUpdateEvent_"}],"description":"Primary API resource payload."}},"required":["data"],"title":"Request[AccountUpdateEvent]","type":"object"},"RequestData_AccountUpdateEvent_":{"description":"Represents request data account update event.","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/AccountUpdateEvents"}],"description":"Domain attributes for this resource."},"id":{"title":"Id","type":"string","description":"Stable identifier for this resource."},"relationships":{"additionalProperties":{"allOf":[{"$ref":"#/components/schemas/RequestRelationshipModel"}],"description":"Relationships value associated with this resource."},"title":"Relationships","type":"object","description":"API relationships to associated resources."},"type":{"enum":["AccountUpdateEvent"],"title":"Type","type":"string","description":"API resource type. Allowed values: `AccountUpdateEvent`."}},"required":["type","attributes"],"title":"RequestData[AccountUpdateEvent]","type":"object"},"AccountUpdateEvents":{"properties":{"account_events":{"allOf":[{"$ref":"#/components/schemas/AccountEvents"}],"description":"One or more account lifecycle events to create or reverse."}},"required":["account_events"],"title":"AccountUpdateEvents","type":"object","description":"Represents account update events."},"AccountEvents":{"properties":{"add_secondary_consumers":{"allOf":[{"$ref":"#/components/schemas/AddSecondaryConsumerEvent"}],"description":"Add one or more secondary consumers to the account."},"charge_off":{"allOf":[{"$ref":"#/components/schemas/ChargeOffEvent"}],"description":"Record or reverse a charge-off, including the charged-off amount."},"close":{"allOf":[{"$ref":"#/components/schemas/CloseEvent"}],"description":"Close the account, recording who initiated the closure."},"collateral_depreciation":{"allOf":[{"$ref":"#/components/schemas/app__schemas__v1__account__account_event__models__CollateralDepreciationEvent"}],"description":"Record collateral depreciation against the account."},"collections":{"allOf":[{"$ref":"#/components/schemas/CollectionsEventBase"}],"description":"Place the account into collections, or reverse a prior collections event."},"credit_line_suspended":{"allOf":[{"$ref":"#/components/schemas/CreditLineSuspensionEvent"}],"description":"Suspend the account's credit line."},"deed_received_mortgage":{"allOf":[{"$ref":"#/components/schemas/app__schemas__v1__account__account_event__models__DeedReceivedMortgageEvent"}],"description":"Record a deed received in lieu of foreclosure on a mortgage account."},"delete":{"allOf":[{"$ref":"#/components/schemas/DeleteEvent"}],"description":"Delete the account from furnishing, with a deletion reason."},"dispute_completed":{"allOf":[{"$ref":"#/components/schemas/DisputeCompletedEvent"}],"description":"Close an open dispute for a given dispute source."},"dispute_started":{"allOf":[{"$ref":"#/components/schemas/DisputeStartedEvent"}],"description":"Open a dispute for a given dispute source."},"forbearance":{"allOf":[{"$ref":"#/components/schemas/app__schemas__v1__account__account_event__models__ForbearanceEvent"}],"description":"Place the account into forbearance."},"foreclosure_completed":{"allOf":[{"$ref":"#/components/schemas/ForeclosureCompletedEvent"}],"description":"Record completion of a foreclosure proceeding."},"foreclosure_started":{"allOf":[{"$ref":"#/components/schemas/ForeclosureStartedEvent"}],"description":"Record the start of a foreclosure proceeding."},"loan_redemption":{"allOf":[{"$ref":"#/components/schemas/LoanRedemptionEvent"}],"description":"Record redemption of the loan by the consumer."},"loan_reinstatement":{"allOf":[{"$ref":"#/components/schemas/LoanReinstatementEvent"}],"description":"Reinstate a loan after a prior default or foreclosure action."},"natural_disaster_end":{"allOf":[{"$ref":"#/components/schemas/NaturalDisasterEndEvent"}],"description":"End a natural-disaster accommodation on the account."},"natural_disaster_start":{"allOf":[{"$ref":"#/components/schemas/NaturalDisasterStartEvent"}],"description":"Start a natural-disaster accommodation on the account."},"refinance_modification":{"allOf":[{"$ref":"#/components/schemas/RefinanceModificationEvent"}],"description":"Record a refinance or loan modification, supplying the new contract term and optionally a new reported account number."},"remove_secondary_consumers":{"allOf":[{"$ref":"#/components/schemas/RemoveSecondaryConsumerEvent"}],"description":"Remove one or more secondary consumers from the account."},"remove_transfer":{"allOf":[{"$ref":"#/components/schemas/RemoveTransferEvent"}],"description":"Remove a previously reported transfer from the account."},"repossession":{"allOf":[{"$ref":"#/components/schemas/app__schemas__v1__account__account_event__models__RepossessionEvent"}],"description":"Record repossession of the account's collateral."},"short_sale":{"allOf":[{"$ref":"#/components/schemas/ShortSaleEvent"}],"description":"Record a short sale of the account's collateral."},"transfer":{"allOf":[{"$ref":"#/components/schemas/TransferEvent"}],"description":"Record transfer or sale of the account to another party."},"voluntary_surrender":{"allOf":[{"$ref":"#/components/schemas/app__schemas__v1__account__account_event__models__VoluntarySurrenderedEvent"}],"description":"Record voluntary surrender of the account's collateral."}},"title":"AccountEvents","type":"object","description":"Container for account lifecycle events. Every field is individually optional, but at least one event must be supplied; a request containing no events is rejected. Each supplied event has its own required attributes."},"AddSecondaryConsumerEvent":{"properties":{"consumers":{"items":{"allOf":[{"$ref":"#/components/schemas/SecondaryConsumerInfo"}],"description":"Consumer associated with this resource."},"title":"Consumers","type":"array","description":"Collection of consumers."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"required":["consumers"],"title":"AddSecondaryConsumerEvent","type":"object","description":"Represents add 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."},"consumer_id":{"format":"uuid","title":"Consumer Id","type":"string","description":"Unique Consumer Hub identifier of the secondary consumer."},"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."},"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"},"ChargeOffEvent":{"properties":{"amount":{"minimum":0,"title":"Amount","type":"number","description":"Monetary amount associated with this event, expressed in dollars. Minimum: 0."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/ChargeOffSpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"ChargeOffEvent","type":"object","description":"Represents a charge-off event. `amount` and `special_comment_code` are required when creating a charge-off, but may be omitted when reversing one. An omitted reversal amount defaults to zero."},"ChargeOffSpecialCommentCode":{"description":"An enumeration.","enum":["CHARGE_OFF","ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE","CREDIT_LINE_SUSPENDED"],"title":"ChargeOffSpecialCommentCode","type":"string"},"CloseEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"initiator":{"allOf":[{"$ref":"#/components/schemas/AccountClosedInitiator"}],"default":"CREDITOR","description":"Party that initiated the account action."},"initiator_reverse":{"title":"Initiator Reverse","type":"boolean","description":"Whether the previously reported initiator designation is being reversed."},"initiator_reversed_on":{"format":"date","title":"Initiator Reversed On","type":"string","description":"Date on which the initiator designation was reversed."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/SpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"CloseEvent","type":"object","description":"Represents close event."},"AccountClosedInitiator":{"description":"An enumeration.","enum":["CREDITOR","CONSUMER"],"title":"AccountClosedInitiator"},"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"},"app__schemas__v1__account__account_event__models__CollateralDepreciationEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/CollateralSpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"CollateralDepreciationEvent","type":"object","description":"Represents app schemas v1 account account event models collateral depreciation event."},"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"},"CollectionsEventBase":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/CollectionsSpecialCommentCode"}],"description":"Required Metro 2 special comment code applied when reporting the collections event."}},"required":["special_comment_code"],"title":"CollectionsEventBase","type":"object","description":"Represents collections event base."},"CollectionsSpecialCommentCode":{"description":"An enumeration.","enum":["COLLECTIONS","ACCOUNT_PAID_FULL_LESS_THAN_FULL_BALANCE","CREDIT_LINE_SUSPENDED"],"title":"CollectionsSpecialCommentCode","type":"string"},"CreditLineSuspensionEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"CreditLineSuspensionEvent","type":"object","description":"Represents credit line suspension event."},"app__schemas__v1__account__account_event__models__DeedReceivedMortgageEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/CollateralSpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"DeedReceivedMortgageEvent","type":"object","description":"Represents app schemas v1 account account event models deed received mortgage event."},"DeleteEvent":{"properties":{"deleted_note":{"title":"Deleted Note","type":"string","description":"Deleted note associated with this resource."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"status":{"allOf":[{"$ref":"#/components/schemas/AccountDeletionReason"}],"description":"Reason for deleting the account. Required for a new deletion unless the request is reversing an eligible prior event."}},"title":"DeleteEvent","type":"object","description":"Represents a delete event. `status` is required when creating a deletion. When the new-delete-event behavior is enabled, it may be omitted when reversing an eligible prior deletion."},"AccountDeletionReason":{"description":"An enumeration.","enum":["CONFIRMED_FRAUD","OTHER_REASON_NOT_FRAUD"],"title":"AccountDeletionReason"},"DisputeCompletedEvent":{"properties":{"consumer_disagreed":{"title":"Consumer Disagreed","type":"boolean","description":"Whether consumer disagreed applies."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"source":{"allOf":[{"$ref":"#/components/schemas/DisputeSource"}],"description":"Source associated with this resource."}},"required":["source","consumer_disagreed"],"title":"DisputeCompletedEvent","type":"object","description":"Represents dispute completed event."},"DisputeSource":{"description":"An enumeration.","enum":["FCRA","FCBA","FDCPA"],"title":"DisputeSource"},"DisputeStartedEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"source":{"allOf":[{"$ref":"#/components/schemas/DisputeSource"}],"description":"Source associated with this resource."}},"required":["source"],"title":"DisputeStartedEvent","type":"object","description":"Represents dispute started event."},"app__schemas__v1__account__account_event__models__ForbearanceEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/ForbearanceSpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"ForbearanceEvent","type":"object","description":"Represents app schemas v1 account account event models forbearance event."},"ForbearanceSpecialCommentCode":{"description":"An enumeration.","enum":["ACCOUNT_IN_FORBEARANCE"],"title":"ForbearanceSpecialCommentCode","type":"string"},"ForeclosureCompletedEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"ForeclosureCompletedEvent","type":"object","description":"Represents foreclosure completed event."},"ForeclosureStartedEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"ForeclosureStartedEvent","type":"object","description":"Represents foreclosure started event."},"LoanRedemptionEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"LoanRedemptionEvent","type":"object","description":"Represents loan redemption event."},"LoanReinstatementEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"LoanReinstatementEvent","type":"object","description":"Represents loan reinstatement event."},"NaturalDisasterEndEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"NaturalDisasterEndEvent","type":"object","description":"Represents natural disaster end event."},"NaturalDisasterStartEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"NaturalDisasterStartEvent","type":"object","description":"Represents natural disaster start event."},"RefinanceModificationEvent":{"description":"Record a refinance or loan modification. Only permitted for mortgage portfolios. Supplying `account_number` also creates an account-number change event.","properties":{"account_number":{"title":"Account Number","type":"string","description":"New account number to report for the modified loan. When supplied, an account number event is created automatically."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"skip_account_number_reversal":{"default":false,"title":"Skip Account Number Reversal","type":"boolean","description":"When reversing, leave the previously reported account number in place instead of reverting it."},"terms_duration":{"title":"Terms Duration","type":"string","description":"Three-character Metro 2 contract term for the modified loan: a zero-padded duration such as `024`, or `REV`/`LOC`."}},"required":["terms_duration"],"title":"RefinanceModificationEvent","type":"object"},"RemoveSecondaryConsumerEvent":{"properties":{"consumer_ids":{"items":{"format":"uuid","type":"string","description":"Unique identifier for the associated consumer id."},"title":"Consumer Ids","type":"array","description":"Unique identifiers of the affected consumers."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"removal_type":{"allOf":[{"$ref":"#/components/schemas/SecondaryRemovalType"}],"description":"Removal type associated with this resource."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"required":["consumer_ids"],"title":"RemoveSecondaryConsumerEvent","type":"object","description":"Represents remove secondary consumer event."},"SecondaryRemovalType":{"description":"An enumeration.","enum":["TERMINATED","DELETE_CONSUMER"],"title":"SecondaryRemovalType"},"RemoveTransferEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"RemoveTransferEvent","type":"object","description":"Represents remove transfer event."},"app__schemas__v1__account__account_event__models__RepossessionEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/CollateralSpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"RepossessionEvent","type":"object","description":"Represents app schemas v1 account account event models repossession event."},"ShortSaleEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."}},"title":"ShortSaleEvent","type":"object","description":"Represents short sale event."},"TransferEvent":{"properties":{"buyer_name":{"title":"Buyer Name","type":"string","description":"Name of the party buying or receiving the account."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"furnished_id":{"title":"Furnished Id","type":"string","description":"Unique identifier for the associated furnished."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"transfer_type":{"allOf":[{"$ref":"#/components/schemas/TransferType"}],"description":"Direction of the transfer: `BUY` or `SELL`."}},"required":["buyer_name","transfer_type"],"title":"TransferEvent","type":"object","description":"Represents transfer event."},"TransferType":{"description":"An enumeration.","enum":["SELL","BUY"],"title":"TransferType","type":"string"},"app__schemas__v1__account__account_event__models__VoluntarySurrenderedEvent":{"properties":{"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"special_comment_code":{"allOf":[{"$ref":"#/components/schemas/CollateralSpecialCommentCode"}],"description":"Metro 2 special comment code applied by this event."}},"title":"VoluntarySurrenderedEvent","type":"object","description":"Represents app schemas v1 account account event models voluntary surrendered event."},"RequestRelationshipModel":{"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."}},"title":"RequestRelationshipModel","type":"object","description":"Represents request relationship model."},"ResourceIdentifier":{"description":"https://jsonapi.org/format/#document-resource-identifier-objects","properties":{"id":{"title":"Id","type":"string","description":"Stable identifier for this resource."},"meta":{"title":"Meta","type":"object","description":"Metadata associated with the response."},"type":{"title":"Type","type":"string","description":"API resource type."}},"required":["id","type"],"title":"ResourceIdentifier","type":"object"},"Response_Account_":{"description":"Response envelope for account.","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ResponseData_Account_"}],"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."},{"$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[Account]","type":"object"},"ResponseData_Account_":{"description":"Represents response data account.","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/Account"}],"default":{},"title":"Attributes","description":"Domain attributes for this resource."},"id":{"title":"Id","type":"string","description":"Stable identifier for this resource."},"links":{"additionalProperties":{"anyOf":[{"type":"string","description":"Links value associated with this resource."},{"$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":["Account"],"title":"Type","type":"string","description":"API resource type. Allowed values: `Account`."}},"required":["id","type"],"title":"ResponseData[Account]","type":"object"},"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."},"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."},"business_ein":{"title":"Business Ein","type":"string","description":"Employer Identification Number of the business responsible for a commercial account."},"business_name":{"title":"Business Name","type":"string","description":"Legal name of the business responsible for a commercial account."},"business_phone_number":{"title":"Business Phone Number","type":"string","description":"Contact phone number of the business responsible for a commercial account."},"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."},"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."},"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."},"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."},"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."},"paid_off":{"default":false,"title":"Paid Off","type":"boolean","description":"Whether the account has been paid off."},"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."},"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."},"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."},"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`."},"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"},"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."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"reverse":{"title":"Reverse","type":"boolean","description":"Whether this request reverses the corresponding active event."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"status":{"allOf":[{"$ref":"#/components/schemas/BankruptcyStatus"}],"description":"Current lifecycle or processing status."}},"title":"BankruptcyEvent","type":"object","description":"Represents bankruptcy event."},"BankruptcyChapter":{"description":"An enumeration.","enum":["CHAPTER_7","CHAPTER_11","CHAPTER_12","CHAPTER_13"],"title":"BankruptcyChapter","type":"string"},"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."},"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"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."},"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"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."},"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"CollectionsStatus":{"description":"An enumeration.","enum":["PAID_IN_FULL_COLLECTION_ACCOUNT"],"title":"CollectionsStatus","type":"string"},"TermsFrequency":{"description":"The frequency for payments due.","enum":["DEFERRED","WEEKLY","BIWEEKLY","SEMIMONTHLY","MONTHLY"],"title":"TermsFrequency","type":"string"},"AccountDeleteEvent":{"properties":{"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"deleted_notes":{"title":"Deleted Notes","type":"string","description":"Free-form note explaining why the account was deleted."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"external_delete_date":{"format":"date","title":"External Delete Date","type":"string","description":"Date the partner recorded the deletion in its own system."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"status":{"allOf":[{"$ref":"#/components/schemas/AccountDeletionReason"}],"description":"Reason the account was deleted."}},"title":"AccountDeleteEvent","type":"object","description":"Active deletion event recorded against an account."},"Dispute":{"properties":{"consumer_disagreed":{"title":"Consumer Disagreed","type":"boolean","description":"Whether consumer disagreed applies."},"effective_date":{"format":"date-time","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for 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."},"reversed_on":{"format":"date-time","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"DisputeStatus":{"description":"An enumeration.","enum":["DISPUTE_STARTED","DISPUTE_COMPLETED"],"title":"DisputeStatus"},"Forbearance":{"properties":{"amount":{"minimum":0,"title":"Amount","type":"number","description":"Monetary amount associated with this event, expressed in dollars. Minimum: 0."},"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"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."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for 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."},"reversed_on":{"format":"date-time","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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"},"Lien":{"properties":{"amount":{"minimum":0,"title":"Amount","type":"number","description":"Monetary amount associated with this event, expressed in dollars. Minimum: 0."},"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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"},"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."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for 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."},"reversed_on":{"format":"date-time","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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"},"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"},"PaymentDefaultEvent":{"properties":{"created_at":{"format":"date","title":"Created At","type":"string","description":"Date on which the event was recorded by the service."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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"},"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."},"effective_date":{"format":"date","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"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."},"initiator_reversed_on":{"format":"date-time","title":"Initiator Reversed On","type":"string","description":"Date on which the initiator designation was reversed."},"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."},"reversed_on":{"format":"date","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"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"},"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."},"effective_date":{"format":"date-time","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"reversed":{"title":"Reversed","type":"boolean","description":"Whether the event has been reversed as of today."},"reversed_on":{"format":"date-time","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"skip_account_number_reversal":{"title":"Skip Account Number Reversal","type":"boolean","description":"Whether reversing this event leaves the reported account number in place."},"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."}},"title":"RefinanceModification","type":"object"},"SecondaryConsumerEvent":{"properties":{"account_id":{"format":"uuid","title":"Account Id","type":"string","description":"Unique identifier of the furnished account."},"effective_date":{"format":"date-time","title":"Effective Date","type":"string","description":"Date on which the event takes effect for furnishing and status calculations."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for this resource."},"organization_id":{"format":"uuid","title":"Organization Id","type":"string","description":"Unique identifier of the organization that owns the resource."},"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."},"reversed_on":{"format":"date-time","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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."},"SecondaryStatus":{"description":"An enumeration.","enum":["ADD_SECONDARY_CONSUMER","REMOVE_SECONDARY_CONSUMER"],"title":"SecondaryStatus"},"SecondaryMarket":{"description":"Secondary-market owner or MERS designation reported for a mortgage account.","enum":["FANNIE_MAE","FREDDIE_MAC","MERS"],"title":"SecondaryMarket","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."},"id":{"format":"uuid","title":"Id","type":"string","description":"Stable identifier for 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."},"reversed_on":{"format":"date-time","title":"Reversed On","type":"string","description":"Date on which the previously reported event was reversed."},"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"},"LinkHref":{"properties":{"href":{"title":"Href","type":"string","description":"Href associated with this resource."},"meta":{"title":"Meta","type":"object","description":"Metadata associated with the response."}},"required":["href","meta"],"title":"LinkHref","type":"object","description":"Represents link href."},"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."},{"$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."},"JSONAPIErrorResponse":{"properties":{"errors":{"items":{"allOf":[{"$ref":"#/components/schemas/JSONAPIError"}],"description":"Error associated with this resource."},"title":"Errors","type":"array","description":"Errors that prevented the request from completing."}},"required":["errors"],"title":"JSONAPIErrorResponse","type":"object","description":"Error representation used when a request cannot be completed (jsonapierror response)."},"JSONAPIError":{"properties":{"detail":{"default":"","title":"Detail","type":"string","description":"Human-readable detail explaining the result or error."},"status":{"title":"Status","type":"integer","description":"Bloom internal error code, computed as `error group * 100 + error number`. This is not the HTTP status code."},"title":{"title":"Title","type":"string","description":"Short, human-readable summary of the error."}},"required":["title"],"title":"JSONAPIError","type":"object","description":"Error representation used when a request cannot be completed (jsonapierror)."},"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)."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string","description":"Loc associated with this resource."},{"type":"integer","description":"Loc associated with this resource."}],"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."},"type":{"title":"Error Type","type":"string","description":"API resource type."}},"required":["loc","msg","type"],"title":"ValidationError","type":"object","description":"Error representation used when a request cannot be completed (validation error)."}}},"paths":{"/v2/furnishment/accounts/{account_id}/events":{"post":{"description":"This is the single endpoint that captures every account lifecycle event. Each event is\nindividually optional, but at least one must be provided; a request with no events is\nrejected. Each event has its own required attributes, and every event accepts\n`effective_date`, `reverse`, and `reversed_on` to record or reverse it.\n\nSupported events:\n- `add_secondary_consumers`: Add one or more secondary consumers to an account.\n- `charge_off`: Report a charge-off. Either the unpaid balance is reported as a loss, or\n  the account was paid in full after a charge-off. Reporting an unpaid balance as a loss\n  requires the previous statement to be at least 30 days delinquent.\n- `close`: Report that the account was closed, including which party initiated it.\n- `collateral_depreciation`: Report that a credit line was reduced or suspended due to\n  collateral depreciation. Intended for home equity and other secured lines of credit.\n- `collections`: Report that the account was assigned to internal or external collections.\n- `credit_line_suspended`: Report an account whose credit line has been suspended.\n- `deed_received_mortgage`: Report a deed received in lieu of foreclosure on a mortgage.\n- `delete`: Create a delete account event. This soft-deletes the account.\n- `dispute_completed`: Report a dispute completed event for a dispute source.\n- `dispute_started`: Report a dispute started event for a dispute source.\n- `forbearance`: Report that the account entered forbearance.\n- `foreclosure_completed`: Report a foreclosure completed event. A `foreclosure_started`\n  event must already exist for the account.\n- `foreclosure_started`: Report a foreclosure started event.\n- `loan_redemption`: Report a loan redemption. A collateral event (voluntary surrender or\n  repossession) must already exist.\n- `loan_reinstatement`: Report a loan reinstatement. A collateral event (voluntary\n  surrender or repossession) must already exist.\n- `natural_disaster_end`: End a natural disaster accommodation. A matching\n  `natural_disaster_start` event must already exist.\n- `natural_disaster_start`: Report an account affected by a natural disaster.\n- `refinance_modification`: Report a refinance or loan modification, including\n  refinancing and renegotiation. Only allowed for mortgage portfolio types. If\n  `account_number` is provided, an account number event is created automatically.\n- `remove_secondary_consumers`: Remove one or more secondary consumers from an account.\n- `remove_transfer`: Remove an existing transfer of the account.\n- `repossession`: Report a repossession event.\n- `short_sale`: Report a short sale event. The account must have a valid account status.\n- `transfer`: Report a sell or buy transfer of the account.\n- `voluntary_surrender`: Report that the consumer voluntarily surrendered collateral.","operationId":"create_account_event_api_v1_accounts__account_id__events__post","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"format":"uuid","title":"Account Id","type":"string","description":"Unique identifier of the furnished account."},"description":"Unique identifier of the furnished account."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request_AccountUpdateEvent_"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response_Account_"}}},"description":"Successful Response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Account Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Conflict detected from request. "},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Create Account Event","tags":["Account Events"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.bloomcredit.io/reference/furnishment-api/account-events/create-account-event.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.