For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Sign in Book a demo

Home Guides API Reference Glossary

Home Guides API Reference Glossary

API Reference

Sign in Book a demo

API Reference Webhooks

Counterparty Onboarding Completed

Payload

1 {
2   "eventType": "counterparty.onboarding.completed",
3   "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
4   "counterpartyId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c"
5 }

A payee-payor relationship was updated

Was this page helpful?

Entity Created

Payload

The payload of this webhook request is an object.

eventTypestringRequired

The type of the event.

entityIdstringRequired

The ID of the entity that owns the counterparty relationship

counterpartyIdstringRequired

The ID of the counterparty

Response

200

any

Return a 200 status to indicate that the data was received successfully.