Delete a webhook

Example

  Onfido.Resources.Webhook.delete("<webhook-id>")

Edit a webhook

Example

  Onfido.Resources.Webhook.delete("<webhook-id>")

Get a webhook

Example

  Onfido.Resources.Webhook.get("<webhook-id>")

List webhooks

Example

  Onfido.Resources.Webhook.list()

Register a webhook

Example

  Onfido.Resources.Webhook.register(%{
    url: "https://yourwebserver.com",
    enabled: true,
    environments: ["live", "sandbox"],
    events: [
      "report.completed",
      "check.completed"
    ]
  })

Verify signature on requests to Onfido webhook Based on https://developers.onfido.com/guide/manual-webhook-signature-verification

Signature comparison requires raw_event_body as a string Once signature is verified it is safe to parse raw_event_body returned from this function

If using Plug, get raw_event_body and signature_header like so:

  {:ok, raw_event_body, conn} = read_body(conn)
  signature_header =
    get_req_header(conn, "X-SHA2-Signature")
    |> Base.decode64()

Example

  Onfido.Resources.Webhook.verify_signature(webhook_token, signature_header, raw_event_body)