Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Events

Get an event

The event-type may be one of:

account-status-created

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "account-status-created",
  "event-payload" : {
    "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw",
    "account-status" : "open"
  },
  "created-at" : "2024-01-01T13:30:00.000Z"
}

account-status-updated

{
  "created-at" : "2024-01-01T17:55:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "account-status-updated",
  "event-payload" : {
    "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw",
    "account-status" : "closed"
  }
}

admission-created

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "admission-created",
  "event-payload" : {
    "admission-status" : "processing",
    "admission-scheme-information" : {
      "payment-scheme" : "fps",
      "end-to-end-identification" : "FQ36X73Jb44ZyQE331GYuxLuWM8N85"
    },
    "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ",
    "created-at" : "2024-01-01T13:20:00.123Z",
    "admission-url" : "/v0/admissions/pa.oRFnmBymXIKoknlbwroj8g",
    "unique-scheme-identifier" : "AB123456789123456N1020220426826159900     ",
    "original-unique-scheme-identifier" : "ZZ123456789123456N1020220426826159900     ",
    "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
  },
  "created-at" : "2024-01-01T13:30:00.000Z"
}

admission-updated

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "admission-updated",
  "event-payload" : {
    "admission-status" : "delivered",
    "admission-scheme-information" : {
      "payment-scheme" : "fps",
      "end-to-end-identification" : "FQ36X73Jb44ZyQE331GYuxLuWM8N85"
    },
    "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ",
    "created-at" : "2024-01-01T18:40:00.014Z",
    "admission-url" : "/v0/admissions/pa.oRFnmBymXIKoknlbwroj8g",
    "unique-scheme-identifier" : "AB123456789123456N1020220426826159900     ",
    "original-unique-scheme-identifier" : "ZZ123456789123456N1020220426826159900     ",
    "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
  },
  "created-at" : "2024-01-01T18:45:00.000Z"
}

decision-created

{
  "created-at" : "2020-01-01T00:00:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "decision-created",
  "event-payload" : {
    "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA",
    "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA",
    "decision-outcome" : "accepted",
    "decision-maker" : "system",
    "decision-notes" : "auto-accepted",
    "created-at" : "1900-01-01T00:00:00.130Z"
  }
}

onboarding-application-created

{
  "created-at" : "2020-01-01T00:00:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "onboarding-application-created",
  "event-payload" : {
    "onboarding-application-url" : "/v0/onboarding/applications/oa.frwOX_PxXnG6PDDp7n6jwQ",
    "created-at" : "1900-01-01T08:55:12.120Z",
    "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg",
    "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA",
    "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA",
    "onboarding-application-status" : "processing"
  }
}

onboarding-application-updated

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "onboarding-application-updated",
  "event-payload" : {
    "onboarding-application-url" : "/v0/onboarding/applications/oa.frwOX_PxXnG6PDDp7n6jwQ",
    "created-at" : "2024-02-03T10:00:00.000Z",
    "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg",
    "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA",
    "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA",
    "decision-outcome" : "accepted",
    "onboarding-application-status" : "complete"
  },
  "created-at" : "2020-01-01T00:00:00.000Z"
}

payment-created

{
  "created-at" : "2024-01-01T15:45:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "payment-created",
  "event-payload" : {
    "creditor" : {
      "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw",
      "creditor-type" : "griffin-bank-account"
    },
    "payment-direction" : "inbound-payment",
    "created-at" : "2024-01-01T15:00:20.237Z",
    "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ",
    "payment-reference" : "Dinner",
    "payment-amount" : {
      "currency" : "GBP",
      "value" : "16.00"
    },
    "payment-type" : "credit-transfer",
    "payment-admissions-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ/admissions",
    "payment-submissions-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ/submissions",
    "debtor" : {
      "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw",
      "account-holder" : "ZxB7REHskP2ghVt9Lh23I5",
      "account-number" : "92526719",
      "account-number-code" : "bban",
      "bank-id" : "053515",
      "bank-id-code" : "gbdsc"
    }
  }
}

submission-created

{
  "created-at" : "2024-01-01T00:00:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "submission-created",
  "event-payload" : {
    "unique-scheme-identifier" : "AB123456789123456N1020220426826159900     ",
    "submission-status" : "processing",
    "submission-scheme-information" : {
      "scheme-status-code-description" : "The payment was accepted by the scheme",
      "scheme-status-code" : "0000",
      "end-to-end-identification" : "AHFIWSJFSOK",
      "payment-scheme" : "fps"
    },
    "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ",
    "created-at" : "2024-01-01T13:23:01.529Z",
    "submission-url" : "/v0/submissions/ps.oRFnmBymXIKoknlbwroj8g",
    "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
  }
}

submission-updated

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "submission-updated",
  "event-payload" : {
    "unique-scheme-identifier" : "AB123456789123456N1020220426826159900     ",
    "submission-status" : "delivered",
    "submission-scheme-information" : {
      "end-to-end-identification" : "FQ36X73Jb44ZyQE331GYuxLuWM8N85",
      "payment-scheme" : "fps"
    },
    "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ",
    "created-at" : "2024-01-01T10:38:32.973Z",
    "submission-url" : "/v0/submissions/ps.oRFnmBymXIKoknlbwroj8g",
    "account-url" : "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
  },
  "created-at" : "2024-01-01T00:00:00.000Z"
}

test-event

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "test-event",
  "event-payload" : { },
  "created-at" : "2020-01-01T00:00:00.000Z"
}

transaction-created

{
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "transaction-created",
  "event-payload" : {
    "account-transaction-url" : "/v0/bank/transactions/tr.KXXPmz1DVQS-X_HVLlTfWQ",
    "processed-at" : "2024-01-01T00:00:00.000Z",
    "post-datetime" : "2024-01-01T00:00:00.000Z",
    "balance-change-direction" : "debit",
    "effective-at" : "2024-01-01T00:00:00.000Z",
    "transaction-origin-type" : "payment",
    "payment-url" : "/v0/payments/pm.x2UcETQsU4enORzXPgL9bQ",
    "reference" : "Dinner",
    "account-url" : "/v0/bank/accounts/ba.JZjyiHUbXEOqy6YWyaR_Jw",
    "balance-change" : {
      "currency" : "GBP",
      "value" : "200.00"
    },
    "account-balance" : {
      "currency" : "GBP",
      "value" : "800.00"
    }
  },
  "created-at" : "2024-01-01T00:00:00.000Z"
}

verification-created

{
  "created-at" : "2020-01-01T00:00:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "verification-created",
  "event-payload" : {
    "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg",
    "created-at" : "1900-01-01T00:00:01.063Z",
    "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA",
    "verification-status" : "in-progress",
    "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA",
    "verification-checks-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA/checks"
  }
}

verification-resource-created

{
  "created-at" : "2025-02-13T17:15:17.865Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "verification-resource-created",
  "event-payload" : {
    "verification-resource-id" : "vr.aVi78djZTiSymFpU-zV60Q",
    "idv-check-status" : "errored",
    "idv-check-url" : "TEST",
    "verification-url" : "/v0/verifications/vn.0khMbqbVSomz4YDdG2YEPQ",
    "display-name" : "02t1y9jKLQp5CdQ4RsxiEuF7QuNDb177Q1Q9Dp0WSL28gDdia5gW7O8lhA2l9Y8w90B1eV1Q23fly6r20ENNJeR",
    "legal-person-url" : "/v0/legal-persons/lp.eopIWRwdVVuk6WsW9GzA2w",
    "idv-check-expires-at" : "2154-10-20",
    "organization-url" : "/v0/organizations/og.VxGLrVDKSB2e1Ps4TtJKrg",
    "verification-resource-type" : "idv-check"
  }
}

verification-resource-updated

{
  "created-at" : "2025-02-13T17:15:17.865Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "verification-resource-updated",
  "event-payload" : {
    "verification-resource-id" : "vr.aVi78djZTiSymFpU-zV60Q",
    "idv-check-status" : "errored",
    "idv-check-url" : "TEST",
    "verification-url" : "/v0/verifications/vn.0khMbqbVSomz4YDdG2YEPQ",
    "display-name" : "02t1y9jKLQp5CdQ4RsxiEuF7QuNDb177Q1Q9Dp0WSL28gDdia5gW7O8lhA2l9Y8w90B1eV1Q23fly6r20ENNJeR",
    "legal-person-url" : "/v0/legal-persons/lp.eopIWRwdVVuk6WsW9GzA2w",
    "idv-check-expires-at" : "2154-10-20",
    "organization-url" : "/v0/organizations/og.VxGLrVDKSB2e1Ps4TtJKrg",
    "verification-resource-type" : "idv-check"
  }
}

verification-updated

{
  "created-at" : "2020-01-01T00:00:00.000Z",
  "event-url" : "/v0/events/ev.d9ImQpReWO2qvCk_wMQjxw",
  "event-type" : "verification-updated",
  "event-payload" : {
    "verification-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA",
    "updated-at" : "1900-01-01T00:03:10.221Z",
    "legal-person-url" : "/v0/legal-persons/lp.7oKVYzj1V-2Y4gXEvdowYA",
    "workflow-url" : "/v0/workflows/wf.ESz-T8PUUfyzYDrxBIUjJg",
    "created-at" : "1900-01-01T00:00:00.408Z",
    "verification-checks-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA/checks",
    "risk-rating" : "low-risk",
    "verification-status" : "checks-complete",
    "verification-risk-assessments-url" : "/v0/verifications/vn.yY5hFwg3URayMz6iqXQcpA/risk-assessments"
  }
}
get/v0/events/{event-id}

Path parameters

event-idstring required

Response

Fetch an event

event-urlstring required

Link to the event.

event-type'onboarding-application-updated' | 'decision-created' | 'payment-created' | 'transaction-created' | 'verification-updated' | 'admission-updated' | 'verification-created' | 'account-status-updated' | 'onboarding-application-created' | 'submission-created' | 'test-event' | 'admission-created' | 'verification-resource-updated' | 'account-status-created' | 'verification-resource-created' | 'submission-updated' required

The type of webhook event. Usually has the form {resource}-{operation}, e.g. payment-updated

event-payloadobject required
created-atstring date-time

ISO 8601 formatted date-time.

Example response

{
  "event-url": "/v0/events/ev.ICAgICAgICBldmVudC1pZA"
}