API Reference
Start typing to search…

Events

The tables below contain the events that are possible to subscribe to.

When creating a subscription, in your request JSON, use the event codes below. The notification you receive may not have all the information that is available regarding a particular status. The tables below list the related API where you can go to retrieve more detailed information. Each event has a link to a sample response body.

Webhook Events by Group

Lead Creation

Event CodeDescription
ONB10018Lead created via organic journey
ONB10025Lead created via API journey
ONB10026Lead created via Broker dashboard
ONB10031Renewal lead created

Application Submission

Event CodeDescription
ONB10009Stage 1 submitted – docs ready for review
ONB10051Stage 1 submitted via API
ONB10050Push-back resolved (requirement cleared)
ONB10029Lead requires further information (Push-backs Guide)
ONB10030Broker added “additional info” in dashboard

Application Rejection

Event CodeDescription
ONB10010Stage 1 rejected (deprecated — use ONB10028)
ONB10012Stage 2 rejected (deprecated)
ONB10028Lead rejected with reasons (Reject, Rescind and Ineligible Codes)
ONB10039Application made Ineligible/Rescinded (Reject, Rescind and Ineligible Codes )

Offers

Event CodeDescription
ONB10011Offers provided (excluding flex offers)
ONB10027Offers expired (30-day expiration)
ONB10056Offer accepted
ONB10057Offer accepted (not via API)

Contracts

Event CodeDescription
ONB10022Contract signed via DocuSign
ONB10023Contract signed via “click sign”
ONB10038Contract sent via DocuSign

Banking Data

Event CodeDescription
ONB10035Settlement/Repayment account ready to fetch
ONB10058Banking data received from merchant

Loan Funding

Event CodeDescription
LOA10013Loan funded (EU only)
LOA10036Loan funded (USA platform and exception flow)
LOA10045Funding bounced back
LOA10059Loan is ready to start receiving repayments

Loan Repayment

Event CodeDescription
LOA10032Loan fully repaid (Repayments Guide)
LOA10040Payment made towards the loan
LOA10041Payment reversal
LOA10042Refund from a loan advance
LOA10043Refund reversal
LOA10055Settlement processed (partner-initiated payments) (EU only)
LOA10046Loan discounted settlement

Loan Outcomes

Event CodeDescription
LOA10033Loan defaulted
LOA10034Loan written-off
LOA10047Loan in Collections
LOA10048Loan out of Collections

Instant Settlement

Event CodeDescription
INS10004Instant Settlement enabled
INS10005Instant Settlement disabled

👋

Please get in touch

If you would like any new events added, please get in touch at [email protected] with the required use case, and we will usually be able to add support for the new event.

All webhook events

Event data structure

All events share the following basic structure:

{
    "EventCode": "ONB10959",
    "Message": "Example message...",
    "EventProperties": {
      "LeadId": "f3c23809-9850-4546-bd08-650068aa55f6",
      "EventId": "874b3183-640a-4fa5-bf49-2e2f063f5e34"
     }
}
📘

Good to know

Most events have added EventProperties that show additional data based on the type and nature of the event.

ONB10018

Lead created via Organic journey

The EventProperties object has the same structure for the events with code ONB10018, ONB10025 and ONB10026

{
  "EventCode": "ONB10018",
  "Message": "Lead created via Organic journey",
  "EventProperties": {
    "LeadId": "54cf5823-0287-4025-92f2-4cd25f02aea0",
    "ThirdPartyCustomerId": "test_123456",
    "OrganisationSignUpData": {
      "CompanyName": "This is a company"
    }
  }
}

ONB10025

Lead created via API journey

{
  "EventCode": "ONB10025",
  "Message": "Lead created via API journey",
  "EventProperties": {
    "LeadId": "54cf5823-0287-4025-92f2-4cd25f02aea0",
    "ThirdPartyCustomerId": "test_123456",
    "OrganisationSignUpData": {
      "CompanyName": "This is a company"
    }
  }
}

ONB10026

Lead created via Broker dashboard journey

{
  "EventCode": "ONB10026",
  "Message": "Lead created via Broker dashboard journey",
  "EventProperties": {
    "LeadId": "54cf5823-0287-4025-92f2-4cd25f02aea0",
    "ThirdPartyCustomerId": "test_123456",
    "OrganisationSignUpData": {
      "CompanyName": "This is a company"
    }
  }
}

ONB10031

A renewal lead has been created

{
  "EventCode": "ONB10031",
  "Message": "A renewal lead has been created",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "IsRenewal": true,
    "ThirdPartyCustomerId": "test_123456"
  }
}

ONB10009

Stage 1 submitted

{
  "EventCode": "ONB10009",
  "Message": "All documents required for review by credit algorithms and underwriters have been submitted",
  "EventProperties": {
    "ThirdPartyCustomerId": "test_123456",
    "LeadId": "11c51f4e-a033-4410-a06a-7f4cc6a9840c"
  }
}

ONB10051

Stage 1 submitted via API

{
  "EventCode": "ONB10051",
  "Message": "The lead has been successfully submitted via API",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e"
  }
}

ONB10050

Push-back Resolved

{
  "EventCode": "ONB10050",
  "Message": "The required information from a lead is resolved.",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "CreditRiskCheckReasonExtended": {
      "AdditionalInfo": "",
      "ReasonCode": "PB018",
      "IsResolved": true
    }
  }
}
📘

Good to Know

You can find more information about push-backs and a list of reason codes on this page.

ONB10029

Lead requires further information (Push-back)

{
  "EventCode": "ONB10029",
  "Message": "Lead requires further information",
  "EventProperties": {
      "ThirdPartyCustomerId": "test_123456",
      "LeadId": "11c51f4e-a033-4410-a06a-7f4cc6a9840c",
      "EventId": "f50458bf-8c49-4025-8973-fa8d2cc4c074",
      "CreditRiskCheckPendingReasons": [
        {
          "Reason": "Overdraft limit confirmation",
          "AdditionalInfo": null,
          "ReasonCode": "PB018"
        },
        {
          "Reason": "Open banking only",
          "AdditionalInfo": null,
          "ReasonCode": "PB020"
        },
        {
          "Reason": "Bank statements - 3/6/12 months (includes open banking)",
          "AdditionalInfo": "{\"Data\":{\"DurationInMonths\":3},\"Text\":\"3 months\"}",
          "ReasonCode": "PB017"
        },
        {
          "Reason": "Personal bank statements",
          "AdditionalInfo": "{\"Data\":{\"Name\":\"Mike Bloggs\"},\"Text\":\"Mike Bloggs\"}",
          "ReasonCode": "PB026"
        }
      ]
    }
}
📘

Good To Know

The AdditionalInfo object in the push-back webhook is a JSON-formatted string with escaped characters. To convert it to a usable JSON object in code, you'd need to un-escape it first and then parse it as JSON

ONB10028

Lead has been rejected with reasons provided

{
  "EventCode": "ONB10028",
  "Message": "Lead has been rejected with reasons provided",
  "EventProperties": {
    "LeadId": "54cf5823-0287-4025-92f2-4cd25f02aea0",
    "ThirdPartyCustomerId": "test_123456",
    "CreditRiskCheckRejectedPartnerReasons": [
      {
        "Reason": "Other",
        "ReasonCode": "RJ033"
      }
    ]
  }
}
📘

Good to Know

There are many different reasons a lead may be rejected, rescinded, or determined ineligible. You can find a list of the codes on this page.

ONB10039

The application has been 'Rescinded' or made 'Ineligible'

{
  "EventCode": "ONB10039",
  "Message": "The application has been made 'Ineligible' or 'Rescinded' (see properties for more detail)",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "ThirdPartyCustomerId": "test_123456",
    "LeadState": "rescinded",
    "LeadStateReasons": [
      {
        "Reason": "Partner Revoke: Application Incomplete",
        "AdditionalInfo": "Test",
        "ReasonCode": "RS014"
      }
    ]
  }
}
{
  "EventCode": "ONB10039",
  "Message": "The application has been made 'Ineligible' or 'Rescinded' (see properties for more detail)",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "ThirdPartyCustomerId": "test_123456",
    "LeadState": "ineligible",
    "LeadStateReasons": [
      {
        "Reason": "Not within Partner requirements",
        "AdditionalInfo": "test",
        "ReasonCode": "EL010"
      }
    ]
  }
}

ONB10011

Offers provided

{
  "EventCode": "ONB10011",
  "Message": "Offers Provided",
  "EventProperties": {
    "ThirdPartyCustomerId": "test_123456",
    "LeadId": "5f2f4462-e569-4e4a-922e-9720498b3b58",
    "MinFundingAmount": 0,
    "MaxFundingAmount": 0,
    "Offers": [
      {
        "OfferId": "11420e44-2022-4ae0-9e15-654da88a3f5c",
        "YouWillGet": "15000.0",
        "YouWillRepay": "20000.0",
        "CurrencyISOCode": "USD",
        "Sweep": "20.0",
        "DaysUntilRepayment": 180
      }
    ]
  }
}

Offers provided (direct debit)

{
  "EventCode": "ONB10011",
  "Message": "Offers Provided",
  "EventProperties": {
    "LeadId": "465b0f37-67fc-4106-abbf-eb4e1b0dd405",
    "ThirdPartyCustomerId": "test_123456",
    "MinFundingAmount": 1930,
    "MaxFundingAmount": 8350,
    "Offers": [
      {
        "OfferId": "2af537c5-9cae-4a9e-b48e-7676a35e0f88",
        "YouWillGet": "7760.0",
        "YouWillRepay": "10398.0",
        "CurrencyISOCode": "EUR",
        "Sweep": "20.0",
        "DaysUntilRepayment": 146,
        "ExpectedRepayment": 498.53,
        "RepaymentMethod": "Direct Debit - Fixed",
        "RepaymentFrequency": "Weekly"
      },
      {
        "OfferId": "e2aa35db-74b1-41d5-a610-abc43392ff98",
        "YouWillGet": "8060.0",
        "YouWillRepay": "10961.0",
        "CurrencyISOCode": "EUR",
        "Sweep": "20.0",
        "DaysUntilRepayment": 154,
        "ExpectedRepayment": 498.23,
        "RepaymentMethod": "Direct Debit - Fixed",
        "RepaymentFrequency": "Weekly"
      },
      {
        "OfferId": "620a92a7-59ef-4ec8-ac8d-ead7c359b55c",
        "YouWillGet": "8350.0",
        "YouWillRepay": "11523.0",
        "CurrencyISOCode": "EUR",
        "Sweep": "20.0",
        "DaysUntilRepayment": 162,
        "ExpectedRepayment": 497.91,
        "RepaymentMethod": "Direct Debit - Fixed",
        "RepaymentFrequency": "Weekly"
      }
    ]
  }
}

ONB10027

Offers expired

{
  "EventCode": "ONB10027",
  "Message": "Offers have expired",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "ThirdPartyCustomerId": "test_123456"
  }
}

ONB10056

Offer Accepted

{
  "EventCode": "ONB10056",
  "Message": "Offer Accepted",
  "EventProperties": {
    "EventId": "c8391cea-5f72-4ddb-b2df-2590aadf1014",
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "Offer": {
      "OfferId": "56abdd92-f861-46c4-88b6-d92f09b3e6aa",
      "YouWillGet": "15000.0",
      "YouWillRepay": "20000.0",
      "CurrencyISOCode": "USD",
      "Sweep": "20.0",
      "DaysUntilRepayment": 180,
      "MaturityDate": "2026-06-19T18:06:17.634Z",
      "RepaymentMethod": "Direct Debit - Fixed"
    }
  }
}

ONB10057

Offer Accepted not via API

{
  "EventCode": "ONB10057",
  "Message": "Offer accepted not via API",
  "EventProperties": {
    "EventId": "cef252cf-ad3b-42eb-86d1-ce4a6c8bd1e2",
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "IsEligibleForInstantSigning": true,
    "Offer": {
      "OfferId": "56abdd92-f861-46c4-88b6-d92f09b3e6aa",
      "YouWillGet": "15000.0",
      "YouWillRepay": "20000.0",
      "CurrencyISOCode": "USD",
      "Sweep": "20.0",
      "MaturityDate": "2026-06-19T18:06:17.634Z",
      "RepaymentMethod": "Direct Debit - Fixed"
    }
  }
}

ONB10022

Contract signed

{
  "EventCode": "ONB10022",
  "Message": "Contract Signed",
  "EventProperties": {
    "LeadId": "f4bddb67-b259-438e-9ab4-ad35cf6a1b29",
    "DocumentSigningId": "234b619b-1d48-47b1-ab7c-4b3b25881f99",
    "ThirdPartyCustomerId": "test_123456",
    "SignedDocuments": [
      {
        "DocumentId": "49a47f74-e884-4a96-80d4-5593f57cff1e",
        "DocumentType": "application/pdf"
      },
      {
        "DocumentId": "4ccc4e8e-608e-447b-a4d9-f534b39cbd63",
        "DocumentType": "application/pdf"
      }
    ]
  }
}

ONB10023

Contract signed via Clicksign

{
  "EventCode": "ONB10023",
  "Message": "Contract Signed via Clickign",
  "EventProperties": {
    "LeadId": "f4bddb67-b259-438e-9ab4-ad35cf6a1b29",
    "DocumentSigningId": "234b619b-1d48-47b1-ab7c-4b3b25881f99",
    "ThirdPartyCustomerId": "test_123456",
    "SignedDocuments": [
      {
        "DocumentId": "49a47f74-e884-4a96-80d4-5593f57cff1e",
        "DocumentType": "application/pdf"
      },
      {
        "DocumentId": "4ccc4e8e-608e-447b-a4d9-f534b39cbd63",
        "DocumentType": "application/pdf"
      }
    ]
  }
}

ONB10038

Contract sent

{
  "EventCode": "ONB10038",
  "Message": "Contract has been sent to Merchant via Docusign",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "ThirdPartyCustomerId": "test_123456"
  }
}

ONB10035

The Settlement/Repayment account details are ready to fetch from the AOL endpoint to begin the re-routing process

{
  "EventCode": "ONB10035",
  "Message": "The Settlement/Repayment account details are ready to fetch from the AOL endpoint to begin the re-routing process",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e"
  }
}

ONB10058

Banking data received from the merchant

{
  "EventCode": "ONB10058",
  "Message": "Banking data received from the merchant",
  "EventProperties": {
    "EventId": "c328cc4c-b158-48a1-8197-7fa40df39272",
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e"
  }
}

LOA10013 and LOA10036

Loan funded

📘

Good to Know

LOA10013 is used in the EU only.

LOA10036 is primarily used in the USA to indicate that the loan has been manually marked as funded.

LOA10013

{
  "EventCode": "LOA10013",
  "Message": "Lead has received funding",
  "EventProperties": {
		"ExpectedRepayment": 759.97,
  	"ThirdPartyCustomerId": "test_123456",
  	"CurrencyISOCode": "EUR",
	  "RepaymentFrequency": "Weekly",
	  "LeadId": "da65dec2-f4b5-4deb-a504-e89a9841d632",
 	  "LoanNumber": 60000427,
 	  "Amount": "20000.00",
 	  "DateFunded": "2025-10-08T00:00:00Z",
  	"OriginalAmount": "22799.0",
  	"Sweep": "10.8",
 	  "FastTrackLeadId": "00000000-0000-0000-0000-000000000000",
 	  "RepaymentMethod": "Direct Debit - Fixed",
 	  "LoanId": "f883902a-728e-43bb-bb1a-65d95452c9da",
 	  "EventId": "6af78c06-4d47-44f3-9b79-d0b3b1563eb6",
    "DateOfFirstRepayment": null
  }
}

LOA10036

{
  "EventCode": "LOA10036",
  "Message": "Lead has received funding via a manual process",
  "EventProperties": {
    "DateFunded": "2025-09-22T00:00:00Z",
    "LoanNumber": 60000172,
    "LoanId": "5b8f5ea7-b8ee-4776-ae48-94ca6e793bb4",
    "Sweep": "20.0",
    "ThirdPartyCustomerId": "test_123456",
    "Amount": "15000.0",
    "OriginalAmount": "20000.0",
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "RepaymentMethod": null,
    "RepaymentFrequency": null,
    "ExpectedRepayment": 0
  }
}

LOA10045

Funding bounce-back

	{
	    "EventCode": "LOA10045",
	    "EventProperties": {
	        "LeadId": "2bee7a34-6308-4ad3-b133-c70444415a04",
	        "LoanId": "ca49c513-5d42-48bb-a043-c4e1885bf6f0"
	    },
	    "Message": "The payment for funding bounced back from the intended bank account"
}

LOA10032

The merchant has repaid the full balance of the loan

{
  "EventCode": "LOA10032",
  "Message": "The merchant has repaid the loan",
  "EventProperties": {
    "LoanId": "baf5db4c-a05d-4bdb-add7-a520449bee7a",
    "EventId": "930383ce-f1c7-45f1-ab68-614772e6d0a0",
    "ThirdPartyCustomerId": "test_123456",
    "LeadId": "5f2f4462-e569-4e4a-922e-9720498b3b58"
  }
}

LOA10040

Payment made to advance

{
  "EventCode": "LOA10040",
  "Message": "Loan principal paid ",
  "EventProperties": {
    "CorrelationId": "8f3bf60a-df51-4dbc-9000-88882816dabc",
    "PaymentDate": "2025-10-15T00:00:00Z",
    "ThirdPartyCustomerId": "test_123456",
    "PrincipalRemaining": "-0.00",
    "EventId": "0d83d531-05c4-431e-931f-59d9356eb006",
    "PaymentAmount": "22299.00",
    "LeadId": "1d81fe2e-db08-4eaa-9cc2-4213a2d1f1a9",
    "LoanId": "60ebf364-5474-457b-8caa-251af9803876",
    "CurrencyISOCode": "EUR",
    "PaymentTypeDetails": {
      "PaymentType": "Settlement",
      "SettlementReference": "test repay",
      "SettlementAmount": "500000.00"
    }
  }
}

LOA10041

Reversal from advance

{
    "EventCode": "LOA10041",
    "EventProperties": {
        "Amount": "10.00",
        "LeadId": "113222a1-1a89-4ef0-bda3-bad07224fe11",
        "LoanId": "d90c9fc1-cdd0-4dfc-810a-e2bab1f76199",
        "PaymentDate": "2023-10-20T00:00:00Z",
        "PrinciplaRemaining": "9890.40"
    },
    "Message": "A previously made payment towards a loan was reversed "
}

LOA10042

Refund from advance

	{
	    "EventCode": "LOA10042",
	    "EventProperties": {
	        "Amount": "10.00",
	        "LeadId": "2bee7a34-6308-4ad3-b133-c70444415a04",
	        "LoanId": "ca49c513-5d42-48bb-a043-c4e1885bf6f0"
	    },
	    "Message": "A Refund was triggered for this loan"
}

LOA10043

Refund reversal for advance

	{
	    "EventCode": "LOA10043",
	    "EventProperties": {
	        "Amount": "10.00",
	        "LeadId": "2bee7a34-6308-4ad3-b133-c70444415a04",
	        "LoanId": "ca49c513-5d42-48bb-a043-c4e1885bf6f0"
	    },
	    "Message": "A Refund was reversed for this loan"
}

LOA10055

Settlement Processed

{
	"EventCode": "LOA10055",
	"EventProperties": {
	 "LoanId": "db775b01-a9d7-484f-a9fa-8d01832d5ca4",
   "TotalSettlementAmount": "23.53",
   "SettlementReference": "test1",
   "ThirdPartyCustomerId": "test_123456",
	 "PaymentsToLenders": [
   {
     "Amount": "23.53",
     "PaymentCorrelationId": "9158db65-c41f-4588-af03-d3e1e6a04476"
    }
  ],
  "LeadId": "c309b8a4-6a53-42c1-bd2b-50d35613f602"
}

LOA10046

Loan discounted settlement

{
  "EventCode": "LOA10046",
  "Message": "A discounted repayment amount has been finalised for this loan ",
  "EventProperties": {
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e",
    "LoanId": "5b8f5ea7-b8ee-4776-ae48-94ca6e793bb4"
  }
}

LOA10033

The loan has defaulted due to repayment under-performance

{
    "EventCode": "LOA10033",
    "Message": "The loan has defaulted and is now in our recoveries process",
    "EventProperties": {
        "LoanId": "f926rfc2-30b6-4821-89c7-2a3f11dda380",
        "LeadId": "f926dgc2-30r6-4721-89c7-2a3f21dfa380"
    }
}

LOA10034

The loan has been written-off due to repayment under-performance

{
    "EventCode": "LOA10034",
    "Message": "The loan has been written-off",
    "EventProperties": {
        "LoanId": "f926rfc2-30b6-4821-89c7-2a3f11dda380",
        "LeadId": "f926dgc2-30r6-4721-89c7-2a3f21dfa380"
    }
}

LOA10047

Loan in Collections

{
  "EventCode": "LOA10047",
  "Message": "The merchant has entered YouLend's Collections process",
  "EventProperties": {
    "ThirdPartyCustomerId": "test_123456",
    "LoanId": "5b8f5ea7-b8ee-4776-ae48-94ca6e793bb4",
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e"
  }
}

LOA10048

Loan out of Collections

{
  "EventCode": "LOA10048",
  "Message": "The merchant has been taken out of YouLend's Collections process ",
  "EventProperties": {
    "ThirdPartyCustomerId": "test_123456",
    "LoanId": "5b8f5ea7-b8ee-4776-ae48-94ca6e793bb4",
    "LeadId": "511898ff-3a66-4ebd-8508-22c94c05416e"
  }
}

LOA10059

Loan is ready to start receiving repayments

{
  "EventCode": "LOA10059",
  "Message": "Loan is ready to start receiving repayments",
  "EventProperties": {
    "EventId": "1ca69cab-3ca1-4e46-ad1d-ba59302a3673",
    "LoanNumber": 60000487,
    "ThirdPartyCustomerId": "testdecline",
    "LoanId": "49156956-7173-4da5-84b9-68fd8dcb2fd3",
    "LeadId": "34609fb9-04bc-418a-a872-d0238739d274"
  }
}

INS10004

The instant settlement is enabled

{
    "EventCode": "INS10004",
    "Message": "Instant Settlement has been enabled",
    "EventProperties": {
        "InstantSettlementNumber": 30000000
    }
}

INS10005

The instant settlement is disabled

{
    "EventCode": "INS10005",
    "Message": "Instant Settlement has been disabled",
    "EventProperties": {
        "InstantSettlementNumber": 30000000
    }
}