To access the API Integration section, follow these steps:

• From the left sidebar, click on Buyer to expand the submenu
• Click on API Integration under the Buyer section
• This will open the API Integration » Listing page showing all configured integrations

The listing table displays all buyer API integrations with the following columns:

• Integration ID — unique system-generated identifier for each integration
• Lead Type — the lead type associated with the integration (e.g., Solar, Legal, Payday, Mortgageloan)
• Campaign Name — the buyer campaigns mapped to this integration
• Integration Name — the name of the integration (e.g., Test Solar Integration XML, 4 Legal Integration, Payday Integration)
• Status — ON/OFF toggle to activate or deactivate the integration
• Reg Date — the date and time the integration was created

To view or configure the sending method for an integration:

• Locate the integration you want in the listing table (e.g., 4 Legal Integration)
• Click the Edit (✏️ pencil icon) button in the Act column for that row
• This will open the API Integration » Edit page with multiple configuration tabs

The General Information tab contains the core settings for the integration:

• Lead Type — the lead type this integration is configured for (e.g., Legal)
• Integration Name — the name used to identify this integration across the system
• Status — set to Active or Inactive to enable or disable the integration
• Post Type — select the posting method — Ping & Post or Direct Post
• Live Transfer Phone — optional phone number for live transfer leads
• Notes — internal notes or comments about this integration
• Upload Client Document — attach any relevant client documents by dropping files or clicking to choose

The PHP Code tab allows you to write custom PHP logic that runs during lead processing for this integration:

• Use the code editor to write your custom PHP transformation or validation logic
• Click Sample PHP Code link for reference examples
• Click Validate code before submit to check your PHP code for errors before saving
• WARNING: only a limited set of PHP functions are permitted — including array_map, base64_encode, json_decode, str_replace, trim, md5, and others as listed. Unauthorised functions will be rejected

The Field Mapping tab defines how your system’s lead fields are mapped to the buyer’s API fields:

• Post Method — select the HTTP method used to send data (e.g., HTTP POST Method)
• Authorize Header — enter any authorization header required by the buyer’s API endpoint
• cURL Username / Password — enter credentials if the buyer’s API requires HTTP Basic Authentication
• Post data using API + Buyer Field Mapping — map each of your system’s fields (Our Fields Name) to the corresponding buyer API field name (Buyer Fields Name), with an optional Hardcode Value to always send a fixed value regardless of the lead data. Fields include: Applicant First Name, Applicant Last Name, Applicant Email, Applicant Phone, Universal Leadid, xxTrustedFormCertUrl, IP Address, Landing Page URL, and more
• Use the Ping checkbox on each row to include that field in the Ping request

The Response Mapping tab configures how the system interprets the buyer’s API response for both Ping and Post:

• Ping Response Type / Post Response Type — select the format of the buyer’s response (e.g., XML, JSON)
• Success Ping Response / Success Post Response — enter the value the buyer returns when a lead is accepted (e.g., Accepted)
• Ping Price / Post Price — the field name in the buyer’s response that contains the payout value (e.g., Payout)
• Lead ID — the field name in the buyer’s response that returns their internal lead ID (e.g., LeadID)
• Ping Redirect URL / Post Redirect URL — the field name in the response that contains a redirect URL if applicable
• Ping Error / Post Error — the field name in the response that contains error messages on rejection
• Ping Bidids / Post Phone Number — additional response fields for bid IDs or phone numbers returned by the buyer
• Seller Name / Post Price Reject — optional fields for seller identification and rejection price thresholds
• Buyer Full Ping Response / Buyer Full Post Response — paste a sample full response from the buyer to assist with mapping validation
• Click Validate to test and verify your response mapping configuration

The Campaigns tab shows all buyer campaigns that are currently linked to this integration. For example, the 4 Legal Integration is mapped to the 4 Legal Leads Setup campaign. This gives you a quick reference of which campaigns are using this integration for lead delivery.

Within the API Integration setup, there are three methods available for delivering lead data to buyers:

• Method 1 — Send Using API

  Lead data is delivered directly to the buyer via API integration in real time. This is the most common method used for automated lead delivery — the system sends the lead to the buyer’s endpoint using Ping & Post or Direct Post as configured in the integration settings.

• Method 2 — Send Email

  Lead details are sent to the buyer via Email. Important notes for this method:

  • Works only when the vendor submits leads using Direct Post method instead of Ping & Post
  • To send email to all mapped buyers, ask the vendor to use exclusive=2 in the API post string
  • Without exclusive=2, the lead will be sent to only 1 buyer as per the order set
  • Amount from buyer will not be deducted when using this method
• Method 3 — Send SMS

  Lead details are sent to the buyer via SMS. This method follows the same conditions as Send Email:

  • Works only when the vendor submits leads using Direct Post method instead of Ping & Post
  • To send SMS to all mapped buyers, ask the vendor to use exclusive=2 in the API post string
  • Without exclusive=2, the SMS will be sent to only 1 buyer as per the order set
  • Amount from buyer will not be deducted when using this method