Invoke A Test Webhook Event

Invoke a test webhook event

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>",
    "last_name": "<string>",
    "status": "created",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "date_of_birth": "<string>",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "home",
        "address1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "address2": "<string>"
      }
    ],
    "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"
      }
    ],
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}
'

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

POST

webhooks

invoke

Invoke a test webhook event

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>",
    "last_name": "<string>",
    "status": "created",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "date_of_birth": "<string>",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "home",
        "address1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "address2": "<string>"
      }
    ],
    "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"
      }
    ],
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}
'

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

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 and Verify APIs. Use v2022-09-21.

Available options:

v2022-09-21

Body

application/json

Person Test Event
Business Test Event
External Account Test Event
Transfer Test Event
Verify Account Test Event
Subledger Test Event
Book Transfer Test Event

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

Show child attributes

data.id

string<uuid>

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<date-time>

required

Timestamp when the resource was created.

data.updated_at

string<date-time>

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

PostalAddressResponse · object[]

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

Required array length: 1 element

Show child attributes

data.addresses.id

string<uuid>

required

Orum generated unique id for the resource.

data.addresses.type

enum<string>

required

Type of address.

Available options:

home,

legal

data.addresses.address1

string

required

Address line 1.

Maximum string length: 255

data.addresses.city

string

required

City.

Maximum string length: 255

data.addresses.state

string

required

Uppercase two-character state code of the address.

data.addresses.country

enum<string>

required

2-character ISO country code.

Available options:

US

data.addresses.zip5

string

required

5-digit ZIP Code. Numeric values (0-9) only.

data.addresses.created_at

string<date-time>

required

Timestamp when the resource was created.

data.addresses.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

data.addresses.address2

string

Address line 2.

Maximum string length: 255

data.contacts

ContactResponse · object[]

List of contact information for the person.

Required array length: 1 - 2 elements

Show child attributes

data.contacts.id

string<uuid>

required

Orum generated unique id for the resource.

data.contacts.type

enum<string>

required

Type of contact information associated with a person - 'email' or 'phone'.

Available options:

email,

phone

data.contacts.value

string

required

Email or phone number.

data.contacts.created_at

string<date-time>

required

Timestamp when the resource was created.

data.contacts.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

data.status_reasons

object[]

Array that explains why the person failed verification.

Show child attributes

data.status_reasons.reason_code

string

required

A word-based code that describes the verification failure.

Example:

"invalid_address"

data.status_reasons.reason_code_message

string

required

A human-readable description of the reason code.

Example:

"Address submitted is a non-supported address type"

data.closed_at

string<date-time>

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.

Response

201 response.

Delete Webhook Configuration Overview

⌘I

Auth API

Deliver API

Verify API

Webhooks API

Invoke A Test Webhook Event

Authorizations

Headers

Body

Response