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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the furnished account.

Body Params

Request envelope for account update event.

data
object
required

Primary API resource payload.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json