Retrieve an Event

Changed on
get/events/{event_id}

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/events/{event_id}
  • Auth
    HTTP bearer

Path parameters

event_idstring required

The identifier of the Event.

Response

Event

associated_object_idstring required

The identifier of the object that generated this Event.

associated_object_typestring required

The type of the object that generated this Event.

category'account.created' | 'account.updated' | 'account_number.created' | 'account_number.updated' | 'account_statement.created' | 'account_transfer.created' | 'account_transfer.updated' | 'ach_prenotification.created' | 'ach_prenotification.updated' | 'ach_transfer.created' | 'ach_transfer.updated' | 'blockchain_address.created' | 'blockchain_address.updated' | 'blockchain_offramp_transfer.created' | 'blockchain_offramp_transfer.updated' | 'blockchain_onramp_transfer.created' | 'blockchain_onramp_transfer.updated' | 'bookkeeping_account.created' | 'bookkeeping_account.updated' | 'bookkeeping_entry_set.updated' | 'card.created' | 'card.updated' | 'card_payment.created' | 'card_payment.updated' | 'card_purchase_supplement.created' | 'card_profile.created' | 'card_profile.updated' | 'card_dispute.created' | 'card_dispute.updated' | 'check_deposit.created' | 'check_deposit.updated' | 'check_transfer.created' | 'check_transfer.updated' | 'declined_transaction.created' | 'digital_card_profile.created' | 'digital_card_profile.updated' | 'digital_wallet_token.created' | 'digital_wallet_token.updated' | 'digital_wallet_token_request.created' | 'entity.created' | 'entity.updated' | 'event_subscription.created' | 'event_subscription.updated' | 'export.created' | 'export.updated' | 'external_account.created' | 'external_account.updated' | 'fednow_transfer.created' | 'fednow_transfer.updated' | 'file.created' | 'group.updated' | 'group.heartbeat' | 'inbound_ach_transfer.created' | 'inbound_ach_transfer.updated' | 'inbound_ach_transfer_return.created' | 'inbound_ach_transfer_return.updated' | 'inbound_check_deposit.created' | 'inbound_check_deposit.updated' | 'inbound_fednow_transfer.created' | 'inbound_fednow_transfer.updated' | 'inbound_mail_item.created' | 'inbound_mail_item.updated' | 'inbound_real_time_payments_request_for_payment.created' | 'inbound_real_time_payments_request_for_payment.updated' | 'inbound_real_time_payments_transfer.created' | 'inbound_real_time_payments_transfer.updated' | 'inbound_wire_drawdown_request.created' | 'inbound_wire_transfer.created' | 'inbound_wire_transfer.updated' | 'interest_rate_plan.created' | 'interest_rate_plan.updated' | 'intrafi_account_enrollment.created' | 'intrafi_account_enrollment.updated' | 'intrafi_exclusion.created' | 'intrafi_exclusion.updated' | 'loan_application.created' | 'loan_application.updated' | 'loan_distribution.created' | 'loan_obligation.created' | 'loan_offer.created' | 'loan_offer.updated' | 'loan_purchase_offer.created' | 'loan_purchase_offer.updated' | 'lockbox.created' | 'lockbox.updated' | 'lockbox_address.created' | 'lockbox_address.updated' | 'oauth_connection.created' | 'oauth_connection.deactivated' | 'card_push_transfer.created' | 'card_push_transfer.updated' | 'card_validation.created' | 'card_validation.updated' | 'pending_transaction.created' | 'pending_transaction.updated' | 'physical_card.created' | 'physical_card.updated' | 'physical_card_profile.created' | 'physical_card_profile.updated' | 'physical_check.created' | 'physical_check.updated' | 'plaid_processor_token.created' | 'checkbook.created' | 'checkbook.updated' | 'program.created' | 'program.updated' | 'proof_of_authorization_request.created' | 'proof_of_authorization_request.updated' | 'real_time_decision.card_authorization_requested' | 'real_time_decision.card_balance_inquiry_requested' | 'real_time_decision.digital_wallet_token_requested' | 'real_time_decision.digital_wallet_authentication_requested' | 'real_time_decision.card_authentication_requested' | 'real_time_decision.card_authentication_challenge_requested' | 'real_time_payments_transfer.created' | 'real_time_payments_transfer.updated' | 'real_time_payments_request_for_payment.created' | 'real_time_payments_request_for_payment.updated' | 'sepa_instant_transfer.created' | 'sepa_instant_transfer.updated' | 'swift_transfer.created' | 'swift_transfer.updated' | 'transaction.created' | 'uk_faster_payment_system_transfer.created' | 'uk_faster_payment_system_transfer.updated' | 'wire_drawdown_request.created' | 'wire_drawdown_request.updated' | 'wire_transfer.created' | 'wire_transfer.updated' required

The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

created_atstring date-time required

The time the Event was created.

idstring required

The Event identifier.

type'event' required

A constant representing the object's type. For this resource it will always be event.

Example response

{
  "associated_object_id": "account_in71c4amph0vgo2qllky",
  "associated_object_type": "account",
  "category": "account.created",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "event_001dzz0r20rzr4zrhrr1364hy80",
  "type": "event"
}

Changes

  • 3b8b2f51c3b7Revision changes
    • warning

      added the new loan_purchase_offer.created enum value to the response property for the response status

    • warning

      added the new loan_purchase_offer.updated enum value to the response property for the response status

    • info

      removed the loan_purchase.created enum value from the response property for the response status

  • f18bc78ce862Revision changes
    • warning

      added the new digital_wallet_token_request.created enum value to the response property for the response status