GuidesThe HIVE APIsMobile SDKsJavascript SDK

Dossier event

You can subscribe the Dossier Webhook to receive all events that occur in Dossiers.

The returned object will contain the Dossier in the state at the moment of the event creation. For example, if there's a status change, you'll receive an event with the new status.

Payloads for DOSSIER Subscription Type

{
  "entity": {
    "account_uuid": "18b0f633-8766-4223-adc7-e6c944f794b4",
    "created_at": "2022-10-01T03:59:51.006550614Z",
    "documents": [
      {
        "type": "DRIVER_LICENSE_FRONT"
      },
      {
        "type": "DRIVER_LICENSE_BACK"
      },
      {
        "type": "SELFIE"
      }
    ],
    "dossier_uuid": "c97a2500-4e6a-4a97-b8e4-502ca0045556",
    "external_id": "3b525637-ac97-43ea-9697-c041444e3fcb",
    "primary": false,
    "status": "CREATED",
    "country_of_issuance": "USA",
    "status_reason": "",
    "updated_at": "2022-10-01T03:59:51.006550614Z"
  },
  "event_date": "2022-10-01T03:59:51.251Z",
  "event_retry": 0,
  "event_type": "DOSSIER",
  "event_uuid": "7f4f5ed0-6306-5f81-b0e2-c8e22e5d9f6c",
  "event_version": "2021-11-18.1",
  "program_uuid": "291eecdb-0e55-4e5b-8e51-375bc173a2a9"
}