Jump to Content

Agreements Ready To Sign

Triggered when the agreements for an application are ready and waiting for signatures.

Payload

{
  "event": "agreements_ready_to_sign",
  "event_id": "evt-d4e5f6g7-8901-23de-fghi-4567890123de",
  "application_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "timestamp": "2026-02-12T15:30:00.000Z",
  "external_reference": "YOUR-REF-001",
  "details": {
      "signatures": [
        {
          "signatory_firstname": "John",
          "signatory_lastname": "Smith",
          "signatory_date_of_birth": "1985-03-15",
          "signatory_postcode": "SW1A 1AA",
          "signature_link": "https://secure.bonafidee.com/signsolo.aspx?t=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }
      ]
    }
}

Fields

Field	Type	Required	Description
`event`	string	Yes	Always `"agreements_ready_to_sign"`
`event_id`	string	Yes	Unique identifier for this event
`application_id`	string (UUID)	Yes	The unique application identifier
`timestamp`	string (ISO 8601)	Yes	When the event occurred
`external_reference`	string	Yes	Your external reference ID for the application
`details`	object	Yes	Contains signature details

Signature Object (`message.details.signatures[]`)

Field	Type	Description
`signatory_firstname`	string	First name of the signatory (guarantor)
`signatory_lastname`	string	Last name of the signatory
`signatory_date_of_birth`	string (date)	Date of birth of the signatory
`signatory_postcode`	string	Postcode of the signatory's address
`signature_link`	string (URL)	Direct link for the signatory to sign the agreements electronically

What This Means

The legal agreements have been prepared and are ready for electronic signature. At this stage:

The signatures array contains one entry per guarantor/signatory
Each signatory has a unique signature_link that can be shared with them to complete the signing process
The signatory details (name, date of birth, postcode) can be used to verify the correct person is signing
Partners can forward the signing link to the applicant or display it in their own portal

Important: The signature_link is unique and should be treated as sensitive. Only share it with the intended signatory.