POST - Create Lead

Create a lead using the rest API.

Create a lead

Method: POST

Endpoint: /lead/new

Maximum Length: 255

Headers:

Name	Value
Content-Type	application/json
Authorization	Bearer <API TOKEN>

Body:

Field	Field in Portal	Type	Example		Required?
brokerId	Partner	string	7e8a17fd-3577-48f4-a0e4-6cb83ea204ba	Unique identifier for a broker.
brokerRepId	Partner Contact	string	7e8a17fd-3577-48f4-a0e4-6cb83ea204ba	Identifier for a broker representative.
callClientOrBroker	Call Client Or Broker	string, Enum: [ Call Client, Call Broker ]	Call Client	Flag indicating whether to call the client directly or contact the broker.
companyName	Company	string	Some Text	Name of the company.
firstName	First Name	string	Some Text	First name of the individual.
lastName	Last Name	string	Some Text	Last name of the individual.
abn	ABN	string	Some Text	Australian Business Number. For Australian Leads
acn	ACN	string	Some Text	Australian Company Number. For Australian Leads
amountRequested	Amount Requested	number	123	Amount of funding requested.
averageMonthlyTurnover	Average Monthly Turnover	number	123	Average monthly turnover of the business.
businessAddress	Business Address	object	{ "addressLine1": "string", "addressLine2": "string", "country": "string", "city": "string", "state": "string", "zipCode": "string" }	Registered address of the business.
businessStartDate	Business Start Date	string($date-time)	2024-01-01	Date when the business was established.
callOnBehalfOf	Call On Behalf Of	string	Some Text	Entity on whose behalf the call is being made.
citizenshipStatus	Citizenship Status	string, Enum: [ Permanent Resident, Temporary Resident, Citizen ]	Permanent Resident	Citizenship status of the individual.
crn	CRN	string	Some Text	Company Registration Number. For UK Leads
dateOfBirth	Date Of Birth	string($date-time)	2024-01-01	Date of birth of the individual.
documentId	Document ID	string	Some Text	Illion Document ID, for Bizcap to pull Bank Statements
driversLicenseNumber	Drivers License Number	string	Some Text	Driver's license number.
driverVersionNumber	Driver Version Number	string	Some Text	Version number of the driver's license. For NZ Leads
email	Email	string	[e-mail]	Email address of the individual or business contact.
homeOwner	Home Owner	string, Enum: [ Yes, No ]	Yes	Flag indicating if the individual is a homeowner.
industryCategory	Industry Category	string	Some Text	Category of the industry the business operates in.
industry	Industry	string	Some Text	Specific industry of the business.
loanPurpose	Loan Purpose	string, Enum: [ Equipment Purchase, Inventory / Stock Purchase, Expansion & Growth, Working Capital / Cashflow, Paying off a Business Debt, Renovation, Other ]	Equipment Purchase	Purpose of the loan being requested.
nzbn	NZBN	string	Some Text	New Zealand Business Number. For New Zealand Leads
partnerLeadReferenceId	Partner Lead Reference ID	string	Some Text	Reference identifier for Partners.
phone	Phone	string	[phone]	Phone number of the individual or business contact.
physicalAddress	Physical Address	object	{ "addressLine1": "string", "addressLine2": "string", "country": "string", "city": "string", "state": "string", "zipCode": "string" }	Physical address of the Business.
residentialAddress	Residential Address	object	{ "addressLine1": "string", "addressLine2": "string", "country": "string", "city": "string", "state": "string", "zipCode": "string" }	Residential address of the individual.
secondaryEmail	Secondary Email	string	[e-mail]	Secondary email address for the individual or business.
secondaryPhone	Secondary Phone	string	[phone]	Secondary phone number for the individual or business.
soleDirector	Sole Director	string, Enum: [ Yes, No ]	Yes	Flag indicating if the individual is the sole director of the company.
suitableProducts	Suitable Products	Array of strings, Enum: [ LOC, 2nd Mortgage, Business Loan]	[ "LOC", "2nd Mortgage"]	List of suitable Bizcap products for this applicant.
tradingAddress	Trading Address	object	{ "addressLine1": "string", "addressLine2": "string", "country": "string", "city": "string", "state": "string", "zipCode": "string" }	Address where the business operates or trades.
tradingName	Trading Name	string	Some Text	Trading name of the business.

Request Body Example

{
  "fields": {
    "brokerId": "1e51262b-4f46-4dd2-9970-f12fe67bd",
    "callClientOrBroker": "Call Client",
    "companyName": "Some Text",
    "firstName": "Some Text",
    "lastName": "Some Text",
    "abn": "AU Specific",
    "acn": "AU Specific",
    "amountRequested": 123,
    "averageMonthlyTurnover": 123,
    "brokerRepId": "ee458b33-0039-480a-a62d-cbccce6b",
    "businessAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "country": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string"
    },
    "businessStartDate": "2024-01-01",
    "callOnBehalfOf": "Some Text",
    "citizenshipStatus": "Permanent Resident",
    "crn": "UK Specific",
    "dateOfBirth": "2024-01-01",
    "documentId": "Some Text",
    "driversLicenseNumber": "Some Text",
    "driverVersionNumber": "Some Text",
    "email": "[e-mail]",
    "homeOwner": "Yes",
    "industry": "Some Text",
    "industryCategory": "Some Text",
    "loanPurpose": "Equipment Purchase",
    "nzbn": "Some Text",
    "partnerLeadReferenceId": "Some Text",
    "phone": "[phone]",
    "physicalAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "country": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string"
    },
    "residentialAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "country": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string"
    },
    "secondaryEmail": "[e-mail]",
    "secondaryPhone": "[phone]",
    "soleDirector": "Yes",
    "suitableProducts": [
      "LOC"
    ],
    "tradingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "country": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string"
    },
    "tradingName": "Some Text"
  }
}

Response

200

{
    "id": "817c2962-244a-4519-bdd4-e7877",
    "fields": {
        "bankStatementsUpdateLink": "https://www.bizcap.nz/bankstatements?leadid=817c2962-244a-4519-bdd4-e7877",
        "applicationLink": "https://www.bizcap.nz/more-about-you/?lead_id=817c2962-244a-4519-bdd4-e7877",
        "partnerLeadReferenceId": "Some Text"
    }
}