Event Subscription

Event Subscription Details

Required Fields

• event_subscription_token: string

  • This is required for the API call.

• description: string

  • A description of the subscription.

• disabled: boolean

  • Whether the subscription is disabled.

• event_types: array of objects

  • The types of events that occurred. Possible values include:
    • account_holder_document.updated: Occurs when an account holder's document upload status has been updated.
    • account_holder.created: Occurs when a new account holder is created.
    • account_holder.updated: Occurs when an account holder is updated.
    • account_holder.verification: Occurs when an asynchronous account holder's verification is completed.
    • ... (more events as listed in the provided content)

Token

• token: string

  • Globally unique identifier.

• url: uri

  • This is the required webhook URL.

HTTP Response Status Codes

• 200 OK: A subscription to specific event types.

• 400: A parameter in the query given in the request does not match the valid queries for the endpoint.

• 401: User has not been authenticated.

• 404: The specified resource was not found.

• 422: Unprocessable entity.

• 429: Client has exceeded the number of allowed requests in a given time period.

Example cURL Request

curl --request GET \
     --url https://sandbox.lithic.com/v1/event_subscriptions/event_subscription_token \
     --header 'accept: application/json'

Example Response

{
  "description": "A subscription for all events",
  "disabled": false,
  "token": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga1",
  "url": "https://example.com/webhook"
}