For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API GuideAPI ReferenceChangelog
API GuideAPI ReferenceChangelog
  • API Reference
  • Webhook Reference
      • POSTReferral Created Event
LogoLogo
Webhook ReferenceReferrals

Referral Created Event

Payload
1{
2  "partner_id": "0201110000749410",
3  "referral_id": "2cd722f4-c42a-4238-86fb-541575371ef8",
4  "status": "CREATED",
5  "event_name": "REFERRAL_CREATED",
6  "referral_date": "2025-05-20T19:14:05.878",
7  "additional_details": {
8    "client_reference_id": "REF120536",
9    "service_required": "Other",
10    "country_moving_to": "USA",
11    "ccy_pair": "GBPUSD",
12    "etv": "50,000 - 100,000"
13  },
14  "company": {
15    "name": "Downweed Ltd.",
16    "registration_number": "3283273"
17  },
18  "contact": {
19    "last_name": "Daviess1",
20    "email": "usertest126@example.com",
21    "phone_number": "+614455666544",
22    "first_name": "Joes2",
23    "date_of_birth": "1995-06-01",
24    "mobile_number": "+447128645157",
25    "address": {
26      "street": "123 High Street",
27      "city": "London",
28      "country": "UK",
29      "state": "",
30      "post_code": "SW1A 1AA"
31    }
32  }
33}

Sent when a referral is created successfully or when referral creation fails. This webhook helps you track the status of your referrals in real-time.

Was this page helpful?
Previous

Customer Status Updated Event

Next
Built with

Payload

The payload of this webhook request is an object.
partner_idstringRequired

Partner ID of the partner referring the customer (not required unless using multiple partner accounts)

referral_idstringRequired
Unique identifier for the referral
statusstringRequired
Status of the referral
event_namestringRequired
Event name
customer_idstringOptional
Unique Customer Id generated post registration
failure_messagestringOptional

Failure message to be returned in case status - FAILED

referral_datedatetimeOptional
registration_datedatetimeOptional
first_trade_datedatetimeOptional
additional_detailsobjectOptional
Additional details about the referral's requirements
companyobjectOptional

Company details (required if customer_type is Corporate)

contactobjectOptional
Contact details for the referral

Response

200
Webhook received successfully
400
Invalid payload