Skip to main content

Leads API

H
Written by Hannah Levick
Updated over 5 months ago

Endpoint Information: Below are requests to explain further how to integrate with our endpoint to send leads into sonar.


Leads Endpoint (generic)

Purpose: This endpoint will allow you to send leads directly into Sonar.

Parameter

Value

Description

Parameter Type

Data Type

Authorization

Secret (client secret entered)

Required Parameter

Header

String

LeadSignal

Lead information

Optional Parameter

Body

Object

Request

Attached below is the lead import json response.

The following fields are required to be filled when sending a request to Sonar.

To view all available fields please review the below documentation

Field

Definition

Data Type

If enum options

purpose

"Loan Purpose" is the transaction type

enum

Options

  • Purchase

  • RefinanceCashOut

  • RefinanceRateAndTerm

  • PreApproval

Borrower FirstName

Borrowers first name

string

Borrower LastName

Borrowers last name

string

Borrower Email

Borrowers email

string

City

Subject Property City

string

State

Subject property state

string


Response:

Response Code

Description

200

Success (either created successfully or failed)

401

Unauthorized

404

Not Found


How to get started:

To utilize this endpoint, you must first add the connection within Sonar

Navigate to the Settings tab > Integrations > Add Company Integration > Integration Type = "Leads"

Next, you will want to select a provider

  • Generic - select this provider for the ability to post leads directly to sonar

  • Lendingtree - only select this if you have already set up a lending tree account to purchase leads

Finally, you will need to create the connection

  • Enter your client secret , click "test" and finally "save".

  • Client Secret: This will be needed to authorize the request for the service you are using.

  • Endpoint: This will be endpoint you will need to use to send leads to sonar.

Once your connection is saved, make sure to activate it on the setting page.


Additional Documentation:

Sample Json

  • attached below

Field Definitions:

  • attached below

Attachment icon
Did this answer your question?