Invoke A Test Webhook Event

POST

webhooks

invoke

curl --request POST \
  --url https://api-sandbox.orum.io/webhooks/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "event_type": "person_created",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "status": "created",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "home",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "email",
        "value": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status_reasons": [
      {
        "reason_code": "invalid_address",
        "reason_code_message": "Address submitted is a non-supported address type"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}'

This response does not have an example.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version

enum<string>

required

Version of Deliver API. Use v2022-09-21.

Available options:

v2022-09-21

Body

application/json

event_type

enum<string>

required

The type of event you want to invoke a webhook for.

Available options:

person_created,

person_verified,

person_rejected,

person_restricted,

person_unverified,

person_closed

data

object

required

data.id

string

required

Orum generated unique id for the resource.

data.customer_reference_id

string

required

Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255

data.first_name

string

required

data.last_name

string

required

data.status

enum<string>

required

Status of person in Orum system.

Available options:

created,

verified,

rejected,

restricted,

closed

data.created_at

string

required

Timestamp when the resource was created.

data.updated_at

string

required

Timestamp when the resource was last updated.

data.middle_name

string

data.date_of_birth

string

Date of birth in YYYY-MM-DD format. Note: This field is required for payouts, deposits, or account-to-account transfers. Age must be less than 100 years and greater than 18 years to be verified.

data.addresses

object[]

Address information for the person. Note: This field is required for payouts, deposits, or account-to-account transfers.

Address.

data.contacts

object[]

List of contact information for the person.

Contact information.

data.status_reasons

object[]

Array that explains why the person failed verification.

data.closed_at

string

Timestamp when the status of the resource was set to "closed".

data.metadata

object

Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.

event_type

enum<string>

required

The type of event you want to invoke a webhook for.

Available options:

person_created,

person_verified,

person_rejected,

person_restricted,

person_unverified,

person_closed

data

object

required

data.id

string

required

Orum generated unique id for the resource.

data.customer_reference_id

string

required

Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255

data.first_name

string

required

data.last_name

string

required

data.status

enum<string>

required

Status of person in Orum system.

Available options:

created,

verified,

rejected,

restricted,

closed

data.created_at

string

required

Timestamp when the resource was created.

data.updated_at

string

required

Timestamp when the resource was last updated.

data.middle_name

string

data.date_of_birth

string

Date of birth in YYYY-MM-DD format. Note: This field is required for payouts, deposits, or account-to-account transfers. Age must be less than 100 years and greater than 18 years to be verified.

data.addresses

object[]

Address information for the person. Note: This field is required for payouts, deposits, or account-to-account transfers.

Address.

data.contacts

object[]

List of contact information for the person.

Contact information.

data.status_reasons

object[]

Array that explains why the person failed verification.

data.closed_at

string

Timestamp when the status of the resource was set to "closed".

data.metadata

object

event_type

enum<string>

required

The type of event you want to invoke a webhook for.

Available options:

business_created,

business_verified,

business_rejected,

business_restricted,

business_unverified,

business_closed

data

object

required

data.id

string

required

Orum generated unique id for the resource.

data.customer_reference_id

string

required

Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255

data.legal_name

string

required

The legal name of the business as it appears on official registration forms. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, hashes, colons, forward slashes, and diacritics.

data.status

enum<string>

required

Status of Business.

Available options:

created,

verified,

rejected,

restricted,

closed

data.created_at

string

required

Timestamp when the resource was created.

data.updated_at

string

required

Timestamp when the resource was last updated.

data.business_name

string

A trade name or pseudonym used by the business that is not its officially registered company name. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, hashes, colons, forward slashes, and diacritics.

data.entity_type

string

Describes the type of business entity.

data.tax_id_type

string

The type of tax ID number associated with the business. Note: This field is required for payouts, deposits, or account-to-account transfers.

data.account_holder_name

string

Name of the owner or primary person associated with the business.

data.incorporation_date

string

Date the business was incorporated, in YYYY-MM-DD format.

data.addresses

object[]

Incorporated address information for the business. Note: This field is required for payouts, deposits, or account-to-account transfers. Orum requires a physical address for all registered businesses; aligned with standards mandated by FinCEN and the FDIC. A physical address is a tangible building address, such as a home, office, or office suite. A PO Box is a mailing address, but not a physical address.

Address.

data.contacts

object[]

List of contact information for the business.

Contact information.

data.closed_at

string

Timestamp when the status of the resource was set to "closed".

data.metadata

object

event_type

enum<string>

required

The type of event you want to invoke a webhook for.

Available options:

external_account_created,

external_account_verified,

external_account_rejected,

external_account_restricted,

external_account_unverified,

external_account_closed

data

object

required

A single object of External Account.

event_type

enum<string>

required

The type of event you want to invoke a webhook for.

Available options:

transfer_updated

data

object

required

data.id

string

required

Orum generated unique id for the resource.

data.transfer_reference_id

string

required

Unique reference id for the transfer. Generated by you.

Minimum length: 1

data.amount

integer

required

Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.

Required range: x >= 1

data.currency

enum<string>

required

Currency code in ISO 4217 format. Only USD is supported.

Available options:

USD

data.speed

enum<string>

required

Speed of transfer.

Available options:

asap,

standard,

same_day,

wire

data.status

enum<string>

required

Describes the current status of the transfer.

Available options:

completed,

created,

failed,

pending,

settled

data.created_at

string

required

Timestamp when the resource was created.

data.updated_at

string

required

Timestamp when the resource was last updated.

data.source

object

For use cases that require a Source, information about the transfer funding source, which will be debited.

data.destination

object

Information about the transfer funds destination, which will be credited.

data.status_reasons

object[]

Array that explains why the transfer failed.

For failed transfers - details on why the transfer is in a failed state.

data.account_statement_descriptor

string

Banks can display additional information to help the end user understand why they received funds. This information will appear on both the source and destination bank account statements. The field supports 10 alphanumeric characters for ACH and 140 for RTP.

data.estimated_funds_delivery_date

string

Estimated date that funds will arrive in destination account. Time will always be midnight and should be ignored.

data.metadata

object

data.transfer_group_id

string

Orum generated unique id for the resource.

data.schedule_id

string

Orum generated unique id for the resource.

event_type

enum<string>

required

The type of event you want to invoke a webhook for.

Available options:

verify_account_updated

data

object

required

data.id

string

required

Orum generated unique id for the resource.

data.created_at

string

required

Timestamp when the resource was created.

data.updated_at

string

required

Timestamp when the resource was last updated.

data.account_number

string

required

Account number for US bank account. 4 to 17 digits are acceptable.

data.routing_number

string

required

9-digit American Bankers Association (ABA) routing number.

data.account_holder_name

string

required

Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

data.verification_status

enum<string>

required

Status of account verification.

Available options:

pending,

valid,

closed,

invalid,

failed

data.email

string

Email address to notify once the statement code is sent to the account to verify account control.

data.status_reason

enum<string>

Status reason for failed, invalid, and closed accounts.

Available options:

blocked_account,

closed_account,

deceased_party,

duplicated_transfer,

invalid_account,

invalid_field,

invalid_routing,

regulatory_error,

unavailable_financial_institution,

unexpected_error,

unsupported_transfer

data.ownership_status

enum<string>

Status of account ownership.

Available options:

pending,

full,

partial,

not_a_match,

not_found

data.person

object

Ownership details for a person

data.business

object

Ownership details for a business

data.control_status

enum<string>

Status of account control.

Available options:

pending,

valid,

canceled

data.debit_status

enum<string>

Status of account debit.

Available options:

pending,

valid,

blocked,

failed

data.debit_status_reason

enum<string>

Status reason for failed and blocked accounts.

Available options:

blocked_account,

closed_account,

deceased_party,

duplicated_transfer,

invalid_account,

invalid_field,

invalid_routing,

regulatory_error,

unavailable_financial_institution,

unexpected_error,

unsupported_transfer,

debit_blocked,

unauthorized_transfer

data.estimated_verification_date

string

Estimated date that the account verification will be complete. Time will always be midnight and should be ignored.

Example:

"2023-07-13T00:00:00.000Z"

data.sender_name

string

Name of sender initiating the verification request. This name will appear on the statement and should be recognizable to the account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

Response

201

_mintlify/placeholder

201 response.

Was this page helpful?

Delete Webhook Configuration Overview

curl --request POST \
  --url https://api-sandbox.orum.io/webhooks/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "event_type": "person_created",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "status": "created",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "home",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "email",
        "value": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status_reasons": [
      {
        "reason_code": "invalid_address",
        "reason_code_message": "Address submitted is a non-supported address type"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}'

This response does not have an example.

Auth API

Deliver API

Verify API

Webhooks API

Invoke A Test Webhook Event

Authorizations

Headers

Body

Response