Event types and payloads

Event payloads

Webhooks return an event object with an event_id, event_type, created_at timestamp, and event_data object, which will contain all the fields on the updated resource.

Orum will also send a Signature header on each webhook request we make to your server which you can use to validate the message content and that the webhook did in fact come from Orum. Please see Secure webhooks for additional information.

Note: social_security_number will not be include in the event_data object for persons.

Sample webhook event

{
    "event_id": "2d5lde32-3973-5297-vb32-be24f559ef81",
    "event_type": "external_account_created",
    "created_at": "2022-07-26T18:45:17.441Z",
    "event_data": {
        "external_account": {
            "id": "95f3cv3d-asc3-46b8-a7be-056b903bfd54",
            "account_reference_id": "3f72je56-8901-6907-kp24-lp48f789pw92",
            "customer_reference_id": "6p87p609-9047-8201-mw18-pq92d2039ad23",
            "customer_resource_type": "person",
            "account_type": "checking",
            "account_number": "123456789",
            "routing_number": "912345678",
            "account_holder_name": "Tester Smith",
            "status": "created",
            "created_at": "2022-07-26T18:45:05.435446Z",
            "updated_at": "2022-07-26T18:45:05.435446Z"
        }
    }
}

Event Types

Event Type	Description
person_created	A person was created to represent an individual. The person is not able to send or receive funds.
person_verified	A person passed identity verification and is in verified status. The person is able to send or receive funds.
person_rejected	A person did not pass identity verification and is in rejected status. The person is not able to send or receive funds.
person_restricted	A person matched a sanctions list during watchlist screening. The person is not able to send or receive funds.
person_unverified	A person’s record was updated and the updated record requires identity re-verification. The person has a status of `created` and is not able to send or receive funds.
person_closed	A person has been soft deleted in Orum’s platform. The person is not able to send or receive funds.
business_created	A business was created. The business is not able to send or receive funds.
business_verified	A business passed verification and is in verified status. The business is able to send or receive funds.
business_rejected	A business did not pass verification and is in rejected status. The business is not able to send or receive funds.
business_restricted	A business did not pass verification and is in restricted status. The business is not able to send or receive funds.
business_unverified	A business’s record was updated and the updated record requires re-verification. The business has a status of `created` and is not able to send or receive funds.
business_closed	A business has been soft deleted in Orum’s platform. The business is not able to send or receive funds.
external_account_created	An external was account was created. The external account is not able to send or receive funds.
external_account_verified	An external account passed verification and is in a verified status. The external account is able to send or receive funds.
external_account_rejected	An external account did not pass verification and is in a rejected status. The external account is not able to send or receive funds.
external_account_restricted	An external account was matched against a sanctions watchlist and is in a restricted status. The external account is not able to send or receive funds.
external_account_unverified	An external account's record was updated and the updated record requires re-verification. The external account has a status of `created` and is not able to send or receive funds.
external_account_closed	An external account has been soft deleted from Orum’s platform. The external account is not able to send or receive funds.
transfer_updated	A transfer was created or a transfer has changed status to pending, completed, settled, or failed. Check the `status` on the transfer object for more information.
verify_account_updated	A verification of an account was created or a verification of an account has changed status to verified, rejected, restricted, or closed. Check the `verification_status` on the account object for more information.