Formatting your Data - API

Overview

If you are progressing to sending data via API then the first step is to arrange a call to map out the correct fields and align data format and standards.

For information on encryption standards please see our Security Statements.

Payload Data

Generally the payload data required will look similar to the below. However this may change based on your custom fields and requirements.

• first_name
  • Needed to carry out the messaging and provide the customer/prospects first name for personalisation
• phone_number
  • E.164 format numbers +44 7xxx xxxxxx
• lead_ref
  • Populated with the correct lead reference from your system
  • This will then be used as the UID when sending data back to your system
• application-date
  • The date of application/lead generation in ISO8601 Format
    

Example Payload

{
    "first_name": "John",
    "last_name": "Test",
    "phone_number": "+44770123123",
    "email": "[email protected]",
    "lead_ref": "TestRef",
    "application_date": "2024-10-12T13:36:00Z"
}

Next Steps

Test Endpoint & Token: We will provide a test endpoint so that we can review the lead transfer process and confirm the payloads are properly received. We will also provide the API token via a secure one-time-secret provider to ensure security protocols are in place.

Live Endpoint & Token: Once the API transfer is confirmed on the test endpoint we will then provide access to Live endpoints and tokens using the same process.