Compliance Check Review Required

webhook

risk_report.review_required

The risk_report.review_required event is fired when issues are found with a compliance check on a Company. Manual intervention from a TeamMember will be required to determine whether or not to transact with the Company before Payables and Receivables to that Company are possible.

Payload

The standard-formatted Routable webhook payload.

detail

object

An optional detail object providing more information about the event that occurred.

event_name

string

required

The event that triggered the webhook.

event_resource

string

enum

required

The type of resource a webhook references:

Value	Resource	URL to Query the Resource
`company`	`Company`	`/v2/companies/{object_id}`
`item`	deprecated	Do not use.
`payable`	`Payable`	`/v2/payables/{object_id}`
`payment_method`	`PaymentMethod`	`/v2/companies/{detail.company_id}/payment-methods/{object_id}`
`receivable`	`Receivable`	`/v2/receivables/{object_id}`
`risk_report`	`ComplianceCheck`	`/v2/companies/{detail.company_id}/compliance-checks`
`tax_form`	`TaxForm`	`/v2/companies/{detail.company_id}/tax-forms/{object_id}`
`test`	N/A	Only used for test webhooks sent during setup.

object_id

uuid

required

The ID of the resource associated with this event.

Headers

Routable-Signature

string

An HMAC-SHA256 hash of the value of Routable-Signature-Timestamp, a period, and the raw JSON webhook request body. See https://developers.routable.com/docs/webhooks for details and code samples describing how to decrypt and validate this value.

Routable-Signature-Timestamp

date-time

A timestamp in GMT. Webhook events where the timestamp is more than five minutes old, or in the future, must be rejected by your code with a 401 Unauthorized.

Responses

200

Return a 200 OK status with no body to indicate that the webhook was processed successfully.

401

Return a 401 Unauthorized status with no body if any of the validation steps are unsuccessful when processing the incoming webhook event.