Only this pageAll pages
Powered by GitBook
1 of 22

Bizcap x Bizmate CRM, API Developer Documentation

Bizmate CRM Partner API

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

BIZMATE PORTAL GUIDE

Loading...

Loading...

Loading...

Loading...

Support

Overview

Version 1 of the Bizmate API is structured around REST, HTTP, and JSON.

API endpoint URLs are organized around resources, such as contacts or deals. It uses HTTP methods for indicating the action to take on a resource, and HTTP status codes for expressing error states.

Resources are represented in JSON following a conventional schema.

Leads

Methods GET, POST, PATCH

The Leads API allows users to manage lead data by providing endpoints to create, update, and retrieve leads. This enables seamless integration with the Bizcap system for handling lead information.

Authentication

All requests to the API are authenticated by providing your API TOKEN (bearer access token). The API key should be provided as an HTTP header named Authorization.

Your API TOKEN can be found by logging into the Bizmate CRM, heading to your Account Profile and your API Key will be displayed for use in your requests as the API TOKEN.

Base URL

The API is accessed using a base URL, which serves as the primary point of entry for all requests. This base URL is consistent across all endpoints, ensuring a standardized access point.

Base URL:

https://bizmate.fasttask.net/api/v1

Making Requests:

To interact with specific functionalities of the API, you will append the appropriate endpoint to the base URL.

To make requests to the API, use the following structure:

https://bizmate.fasttask.net/api/v1/{endpoint}

GET - Retrieve Lead by ID

Retrieve the lead related information using the lead id generated as part of create lead API.

Retrieve a Lead

Method: GET

Endpoint: /LEAD/{leadid}

Headers:

Name
Value

Example Request (JavaScript - Fetch):

Example Request (cURL):

Response

Content-Type

application/json

Authorization

Bearer <API TOKEN>

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/lead/{{leadid}}", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
curl --location 'https://bizmate.fasttask.net/api/v1/lead/{{leadid}}' \
--header 'Authorization: Bearer <API TOKEN>'
{
    "id": "",
    "createdAt": "2024-08-02T05:43:45.884Z",
    "createdBy": "ef62415c-ba77-41c2-9328-36ed7eced734",
    "updatedAt": "2024-08-08T00:20:23.435Z",
    "updatedBy": "e3ca507e-3f06-47b8-80d9-62e7f98a1a4e",
    "fields": {
        "status": "Converted",
        "watchers": [],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "delegateTo": {
            "type": "user",
            "id": ""
        },
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "firstName": "Some Text",
        "lastName": "Some Text",
        "companyName": "Some Text",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "residentialAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "businessAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "physicalAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "tradingAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "nzbn": null,
        "phone": "+1111111111",
        "email": "[email protected]",
        "bankStatementsUpdateLink": "",
        "bankStatementsCreditsSenseLink": "",
        "provisoLinkPdf": "",
        "bankStatementsReceived": "No",
        "industryCategory": "Some Text",
        "industry": "Some Text",
        "dateOfBirth": "2024-01-01",
        "driversLicenseNumber": "Some Text",
        "citizenshipStatus": "Permanent Resident",
        "soleDirector": "Yes",
        "loanPurpose": "Equipment Purchase",
        "averageMonthlyTurnover": "123.00",
        "callClientOrBroker": "Call Client",
        "applicationLink": "",
        "documentId": "Some Text",
        "tradingName": "Some Text",
        "applicationCompleted": null,
        "applicationCompletedDate": null,
        "bankStatementsReceivedDate": null,
        "businessStartDate": "2024-01-01",
        "amountRequested": "123.00",
        "internalBdmUser": null,
        "secondaryPhone": "+1111111111",
        "loanType": null,
        "homeOwner": "Yes",
        "secondaryEmail": "[email protected]",
        "suitableProducts": [
            "LOC"
        ],
        "driverVersionNumber": "Some Text",
        "leadSource": "API",
        "numberOfCallsMade": 0,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "convertedDealId": ""
    }
}
{
  "error": "Invalid request"
}

Overview

Key Features


Getting Started

1

Keep an eye on your mailbox for our "Invitation to join: Bizcap Partner Portal."

2

Copy and paste your invitation link into your browser

3

Set up your login details and start submitting leads!

PATCH - Update Lead

Modify/update fields in an existing lead.

Update a Lead

Method: PATCH

Endpoint: /LEAD/{leadid}

Headers:

Name
Value

Since it’s a PATCH method, we can specify only the datapoints that have changed and not the whole raw data. For example, if we would like to change the last name of a lead, below can be used:

All of the datapoints in the POST lead method are available to be updated via the PATCH method.

Example Request (JavaScript - Fetch):

Example Request (cURL):

Response

POST - Upload Files

Upload files to a lead

Upload files to a LEAD

Note: Lead ID from the create lead response is required to upload files to Bizmate.

Method: POST

Endpoint: /attachments/new

Maximum Length: 255

Lead Status

Contains the Status and Sub Status information for leads.

Status
Sub-Status

Bulk Lead Uploads

Save time and effort by easily uploading multiple leads at once, streamlining your workflow and speeding up the process of getting deals to our team.

Monthly Activity Snapshots

Get a clear, visual overview of your monthly performance. Track progress, identify opportunities, and view the number of submitted leads and deals.

Live Deal Updates

Stay informed in real-time with live updates on the status of your deals, ensuring you’re always in the loop.

Easy access to Bizcap APIs

Enjoy seamless integration with our updated API, providing you with better functionality and ease of use.

Lead Submissions

Submit leads via the Submit a Lead button on the homepage, or take advantage of bulk uploads through the Data Center.

Closed

  • Duplicate

  • Do not contact

  • Unqualified

Unreachable

  • Wrong details

Converted

  • Banks In

New

  • Received

  • Pending Duplicate Review

Attempting Contact

  • Attempting 1

  • Attempting 2

  • Attempting 3

  • Attempting 4

Difficulty Contacting

  • Attempting 5

  • Attempting 6

  • Attempting 7

  • Attempting 8

Waiting on Customer

  • Call Back Customer

  • Doing Application

  • Customer requested email only

  • Work in progress

  • With Broker

Not Progressing

  • No longer Required

  • Not ready

  • No reason provided

  • Cost

  • Got another loan facility

  • Term too short

  • Loan amount too low

Content-Type

application/json

Authorization

Bearer <API TOKEN>

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/lead/{{leadid}}", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
curl --location 'https://bizmate.fasttask.net/api/v1/lead/{{leadid}}' \
--header 'Authorization: Bearer <API TOKEN>'
{
  "id": 1,
  "name": "John",
  "age": 30
}
{
  "error": "Invalid request"
}
Headers:
Name
Value

Authorization

Bearer <API TOKEN>

Body:

Field
Field in Portal
Type
Example
Description
Required?

entityType

LEAD

text

LEAD

Identify the entity type

entityId

LEAD_ID

text

Request Body Example:

To upload multiple files, use the format illustrated in the Multiple Files Upload table, ensuring each file entry follows the structure shown, incrementing the index for each attachment.

Type : form-data

Single File Upload:

Key
type
Value

entityType

text

LEAD

entityId

text

2e22bca2-b98e-467c-b9d

attachments[0][type]

text

Bank Statements

attachments[0][fileName]

text

Multiple Files Upload:

Key
type
Value

entityType

text

LEAD

entityId

text

2e22bca2-b98e-467c-b9d

attachments[0][type]

text

Bank Statements

attachments[0][fileName]

text

Response

Submitting Leads

Submitting Individual Leads

Follow these instructions to submit an individual lead

{
        "id": "2794fe94bf",
        "createdAt": "2024-12-03T02:31:33.939Z",
        "updatedAt": "2024-12-03T02:31:33.939Z",
        "updatedBy": "2e6-b3c078a66521",
        "createdBy": "2f078a66521",
        "fields": {
            "fileName": "transaction.pdf",
            "type": "Bank Statements",
            "entityType": "LEAD",
            "entityId": "2e22bca2-b98e-9"
        }
  }
[
{
        "id": "878570914182",
        "createdAt": "2024-12-03T02:34:59.614Z",
        "updatedAt": "2024-12-03T02:34:59.614Z",
        "updatedBy": "2f7af066521",
        "createdBy": "2f7afce6-b3a66521",
        "fields": {
            "fileName": "transaction.pdf",
            "type": "Bank Statements",
            "entityType": "LEAD",
            "entityId": "2e22561ed4579"
        }
    },
    {
        "id": "4ce8412c7ff06",
        "createdAt": "2024-12-03T02:34:59.615Z",
        "updatedAt": "2024-12-03T02:34:59.615Z",
        "updatedBy": "2f7af0521",
        "createdBy": "2f7a8a66521",
        "fields": {
            "fileName": "Drivers_License_Front.jpg",
            "type": "Proof of Identity or ID",
            "entityType": "LEAD",
            "entityId": "2e22bca2-bd4579"
        }
    }
]

7e8a17fd-3577-48f4-a0e4-6cb83ea204ba

Identifier for a LEAD

attachments[0][type]

text, Enum: [ Bank Statements, Proof of Identity or ID, Image ]

Bank Statements

Use the exact values as mentioned in the type

attachments[0][fileName]

text

Some Text

Name of the company.

attachments[0][file]

text

Some Text

File to be attached(only one attachment)

attachments[0][file]

file

transaction.pdf

attachments[0][file]

file

transaction.pdf

attachments[1][type]

text

Proof of Identity or ID

attachments[1][fileName]

text

Drivers_License_Front

attachments[1][file]

file

license.jpg

Deals

Making a Bulk Upload

Follow To submit bulk leads through the Data Center, follow these steps:

Complete the CSV template with the necessary lead information by following the instructions below:

Follow these instructions carefully, failure to do so may result in errors

Download and use the provided CSV template. Make sure your CSV file matches the columns in the template exactly.

You cannot import data for fields that are not in the template.

Saving your file

When saving your file as CSV, choose "CSV (Comma delimited) (*.csv)".

Avoid using "CSV UTF-8" or other formats, as they might cause errors like "File columns do not match with template".

Required Columns

Columns marked with an asterisk (*) are mandatory (e.g. First Name, Last Name)

Name Fields

First Name and Last Name must be separated into their respective columns.

Deal Status

Contains the Status and Sub Status information for deals.

Status
Sub Status

Application Received

  • Banks In

In Progress

  • Under Review

  • Scrubbing

  • Scrubbing Complete

  • Submitted to Credit

Additional Info Required

  • Pending info - with customer

  • Pending info - with ISO

  • Pending info

Approved

  • Pending Stips

  • Pending Presentation

  • Offer Made

  • With ISO

Contract Requested

  • Contract Requested

  • Contract Pending Info

Response Codes

The server will respond with the Response Code for your API Request indicating the status of the request, the reason and description for each are described in the table below.

Response Code
Reason
Description

200

Success

Request made successfully.

400

Bad Request

The request could not be understood by the server due to incorrect syntax. The client SHOULD NOT repeat the request without modifications.

401

Unauthorized

Other Tips & Resources

🔔 Notification Management

  • Real-Time Notifications: Receive notifications whenever the status of a lead or deal changes. Notifications are accessible via the top right notification bell on the portal and via email.

Contract Draft

  • Contract Draft

  • Contact Drafting

  • Contract Drafted

  • Contract Draft - Pending info

Contracts Sent

  • Contract Sent

  • Sent by SS

  • Sent by DS

  • DS Contract Viewed

  • No Response

Pending Settlement

  • Contract Signed

  • Pre-Final Review

  • Final Review

  • Final Review - Pending Info

  • Pending Funding Call

  • Funding Call Complete

  • Funding Waiting Approval

  • Pre-Final Review - Pending Info

  • Funding Call Complete - Awaiting Stips

Settled

  • Performing

  • Not performing

  • Defaulted

  • Closed

Withdrawn

  • Term too short

  • Cost

  • No longer Required

  • Loan Amount Too Low

  • Got another loan facility

  • Not Ready

  • No reason provided

On Hold

  • On Hold

  • On Hold - Credit

  • On Hold - Customer

Declined

  • Time in business too short

  • Revenue too low

  • Serviceability

  • Credit history

  • Bank Statement conduct

  • ATO debt

  • Other debts

  • Not a business

  • High risk industry

  • Prohibited industry

  • Insufficient Documentation

  • Integrity of applicants

  • Has competitor loan

  • Rejected By Credit

  • Customer Declined

This indicates that the request needs user authentication details. The client is allowed to retry the request with an appropriate Authorization header.

403

Forbidden

This indicates that this specific user doesn't have enough access rights to get the data.

404

Not Found

The requested resource does not exist.

Incorrect: Applicant Name = John Smith

Correct: First Name = John Last Name = Smith

Phone Numbers

Always use the international phone format. It should start with "+", followed by the country code and the local number.

Incorrect: Personal Number = 7512093211

Correct: Personal Number = +447512093211

Currency & Numbers

Don't use commas in number fields like Amount Requested or Average Monthly Turnover.

Incorrect: Amount Requested = $20,000

Correct: Amount requested = 20000

Call Client or Broker

This field can only have one of two values in this exact format

👥 Lead Management
  • Submit Leads via API: Easily submit leads through our API integration.

    • API Documentation: Access comprehensive API documentation

  • Submit Singular Leads: Use the Submit a Lead button on the homepage for individual lead submissions.

  • Bulk Lead Uploads: Upload multiple leads at once using the Data Center.

🔎 Search Functionality

Quickly find specific leads or other important information using the search feature.

👤 Account Profile Management

❓ Support and Contact Information

GET - Retrieve List of Leads

Retrieve multiple leads at the same time based on the page and page size

Retrieve Multiple Leads:

Method: GET

Endpoint: /LEAD?page=<page_number>&pageSize=<pagesize>

Headers:

FAQs

How do I obtain my credentials to the Partner Portal?

Your Partnership Manager will provide you with a link to your personal Partner Portal. Simply enter your details to set up your login and password.

What if I have not received an email with the link to access my Partner Portal?

If you haven’t received an email with the access link, please email us:

AU - [email protected]

NZ - [email protected]

UK - [email protected]

We’ll ensure you get access. You can also use this email if you need to change your designated contact email address.

How do I bulk upload leads?

On the homepage, click on the bottom left Company Name, and then select Data Center. Use the provided Google Sheets template in the portal to upload multiple leads efficiently.

How do I track my submitted leads and deals?

The homepage dashboard displays all your submitted leads and deals, updated in real-time. To see the meanings of the different status’ of your leads and deals: click here

How do I change my Partner Portal password?

To change your password, click on the bottom left Company Name on the homepage, then go to Account Profile. Here, you can change your password, upload a profile picture, enable multi-factor authentication, and access API documentation.

Who can I contact if I run into any issues?

For any issues with the Partner Portal, please email us.

AU: [email protected]

NZ: [email protected]

UK: [email protected]

How is my data protected?

Your data is secure and protected by Bizcap’s comprehensive Privacy Policy

AU: Privacy Policy

NZ: Privacy Policy

UK: Privacy Policy

Update Account Details

Keep your account information up to date.

Password Management

Reset and confirm your password.

Multi-Factor Authentication

Enhance security by configuring multi-factor authentication.

Profile Picture

Set and update your profile picture

Technical Support

For technical assistance, email [email protected]

Contact Information

Access our contact details for any further assistance or inquiries.

Name
Value

Content-Type

application/json

Authorization

Bearer <API TOKEN>

Example Request (JavaScript - Fetch):

Example Request (cURL):

Response

{
  "error": "Invalid request"
}
[
    {
    "id": "",
    "createdAt": "2024-08-02T05:43:45.884Z",
    "createdBy": "ef62415c-ba77-41c2-9328-36ed7eced734",
    "updatedAt": "2024-08-08T00:20:23.435Z",
    "updatedBy": "e3ca507e-3f06-47b8-80d9-62e7f98a1a4e",
    "fields": {
        "status": "Converted",
        "watchers": [],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "delegateTo": {
            "type": "user",
            "id": ""
        },
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "firstName": "Some Text",
        "lastName": "Some Text",
        "companyName": "Some Text",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "residentialAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "businessAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "physicalAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "tradingAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "nzbn": null,
        "phone": "+1111111111",
        "email": "[email protected]",
        "bankStatementsUpdateLink": "",
        "bankStatementsCreditsSenseLink": "",
        "provisoLinkPdf": "",
        "bankStatementsReceived": "No",
        "industryCategory": "Some Text",
        "industry": "Some Text",
        "dateOfBirth": "2024-01-01",
        "driversLicenseNumber": "Some Text",
        "citizenshipStatus": "Permanent Resident",
        "soleDirector": "Yes",
        "loanPurpose": "Equipment Purchase",
        "averageMonthlyTurnover": "123.00",
        "callClientOrBroker": "Call Client",
        "applicationLink": "",
        "documentId": "Some Text",
        "tradingName": "Some Text",
        "applicationCompleted": null,
        "applicationCompletedDate": null,
        "bankStatementsReceivedDate": null,
        "businessStartDate": "2024-01-01",
        "amountRequested": "123.00",
        "internalBdmUser": null,
        "secondaryPhone": "+1111111111",
        "loanType": null,
        "homeOwner": "Yes",
        "secondaryEmail": "[email protected]",
        "suitableProducts": [
            "LOC"
        ],
        "driverVersionNumber": "Some Text",
        "leadSource": "API",
        "numberOfCallsMade": 0,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "convertedDealId": ""
    }
}, 
{
    "id": "",
    "createdAt": "2024-08-02T05:43:45.884Z",
    "createdBy": "ef62415c-ba77-41c2-9328-36ed7eced734",
    "updatedAt": "2024-08-08T00:20:23.435Z",
    "updatedBy": "e3ca507e-3f06-47b8-80d9-62e7f98a1a4e",
    "fields": {
        "status": "Converted",
        "watchers": [],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "delegateTo": {
            "type": "user",
            "id": ""
        },
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "firstName": "Some Text",
        "lastName": "Some Text",
        "companyName": "Some Text",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "residentialAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "businessAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "physicalAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "tradingAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "country": "string",
            "city": "string",
            "state": "string",
            "zipCode": "string",
            "fullAddress": "string, string, string, string, string, string"
        },
        "nzbn": null,
        "phone": "+1111111111",
        "email": "[email protected]",
        "bankStatementsUpdateLink": "",
        "bankStatementsCreditsSenseLink": "",
        "provisoLinkPdf": "",
        "bankStatementsReceived": "No",
        "industryCategory": "Some Text",
        "industry": "Some Text",
        "dateOfBirth": "2024-01-01",
        "driversLicenseNumber": "Some Text",
        "citizenshipStatus": "Permanent Resident",
        "soleDirector": "Yes",
        "loanPurpose": "Equipment Purchase",
        "averageMonthlyTurnover": "123.00",
        "callClientOrBroker": "Call Client",
        "applicationLink": "",
        "documentId": "Some Text",
        "tradingName": "Some Text",
        "applicationCompleted": null,
        "applicationCompletedDate": null,
        "bankStatementsReceivedDate": null,
        "businessStartDate": "2024-01-01",
        "amountRequested": "123.00",
        "internalBdmUser": null,
        "secondaryPhone": "+1111111111",
        "loanType": null,
        "homeOwner": "Yes",
        "secondaryEmail": "[email protected]",
        "suitableProducts": [
            "LOC"
        ],
        "driverVersionNumber": "Some Text",
        "leadSource": "API",
        "numberOfCallsMade": 0,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "convertedDealId": ""
    }
}
]
const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/lead?page=1&pageSize=100", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
curl --location 'https://bizmate.fasttask.net/api/v1/lead?page=1&pageSize=100' \
--header 'Authorization: Bearer <API TOKEN>'

Call Client

Call Broker

POST - Create Lead

Create a lead using the rest API.

Create a lead

Method: POST

Endpoint: /LEAD/new

Maximum Length: 255

Headers:

Name
Value

Body:

Field
Field in Portal
Type
Example
Required?

Request Body Example

Response

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.

brokerContactEmail

Broker Contact Email

string

[email protected]

Email address of the broker contact

brokerContactName

Broker Contact Name

string

Some Text

Name of the broker contact

brokerContactNumber

Broker Contact Number

string

+6128884565

Phone number of the broker contact

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

[email protected]

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.

notes

Notes

string

Some Text

Primary notes field

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.

partnerNotes

Partner Notes

string

Some Text

Additional notes.

phone

Phone

string

+6128884565

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

[email protected]

Secondary email address for the individual or business.

secondaryPhone

Secondary Phone

string

+6128884565

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.

uen

UEN

string

Some Text

UEN of the business

Content-Type

application/json

Authorization

Bearer <API TOKEN>

brokerId

Partner

string

7e8a17fd-3577-48f4-a0e4-6cb83ea204ba

Unique identifier for a broker.

brokerRepId

Partner Contact

string

7e8a17fd-3577-48f4-a0e4-6cb83ea204ba

{
  "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,
    "brokerContactEmail": "[email protected]",
    "brokerContactName": "Some Text",
    "brokerContactNumber": "+1111111111"
    "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": "[email protected]",
    "homeOwner": "Yes",
    "industry": "Some Text",
    "industryCategory": "Some Text",
    "loanPurpose": "Equipment Purchase",
    "notes": "Some Text",
    "nzbn": "Some Text",
    "partnerLeadReferenceId": "Some Text",
    "partnerNotes": "Some Text",
    "phone": "+1111111111",
    "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": "[email protected]",
    "secondaryPhone": "+1111111111",
    "soleDirector": "Yes",
    "suitableProducts": [
      "LOC"
    ],
    "tradingAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "country": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string"
    },
    "tradingName": "Some Text",
    "uen": "Some Text"
  }
}
{
    "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"
    }
}

GET - Retrieve Deal by ID

Retrieve the deal related information using the deal id.

Retrieve a Deal

Method: GET

Endpoint: /DEAL/{dealid}

Headers:

Name
Value

Fields
Possible Values

Example Request (JavaScript - Fetch):

Example Request (cURL):

Response

subStatus(Contract Requested)

Contract Requested Contract Pending Info

subStatus(Contract Draft)

Contract Drafting Contract Drafted Contract Draft - Pending Info Pre-Send Review

subStatus(Contracts Sent)

Contract Sent Sent by SS Sent by DS DS Contract Viewed No Response

subStatus(Pending Settlement)

Contract Signed Pre-Final Review

Pre-Final Review - Pending Info Final Review Final Review Working Final Review - Pending Info Pending Funding Call - Awaiting Stips Pending Funding Call Funding Call Complete Funding Waiting Approval

subStatus(Settled)

Performing Not performing Defaulted Closed

subStatus(Withdrawn)

Term too short Cost No longer Required Loan Amount Too Low Got another loan facility Not Ready No reason provided

subStatus(On Hold)

On Hold On Hold - Credit On Hold - Customer

subStatus(Declined)

Time in business too short Revenue too low Serviceability Credit History Bank statement conduct ATO debt Other debts Not a business High risk industry Prohibited industry Insufficient Documentation Integrity of applicants Has competitor loan Rejected By Credit Customer Declined

callClientOrBroker

Call Client Call Broker

Content-Type

application/json

Authorization

Bearer <API TOKEN>

loanType

New Renewal Add On Refinance

status

Application Received In Progress Additional Info Required Approved

Contract Requested

Contract Draft Contracts Sent Pending Settlement Settled Withdrawn

On Hold Declined

subStatus(Application Received)

Banks In

subStatus(In Progress)

Under Review Scrubbing Scrubbing Complete Submitted to Credit

subStatus(Additional Info Required)

Pending info - with customer Pending info - with ISO Pending info

subStatus(Approved)

Pending Stips Pending Presentation Offer Made With ISO

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/deal/{{dealid}}", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
curl --location 'https://bizmate.fasttask.net/api/v1/deal/{{dealid}}' \
--header 'Authorization: Bearer <API TOKEN>'
{
    "id": "id",
    "createdAt": "2024-08-08T00:20:15.867Z",
    "createdBy": "",
    "updatedAt": "2024-08-08T00:20:16.551Z",
    "updatedBy": "",
    "fields": {
        "status": "Application Received",
        "watchers": [
            {
                "type": "user",
                "id": ""
            }
        ],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "name": "Some Text",
        "customer": {
            "id": "",
            "name": "Some Text"
        },
        "callClientOrBroker": "Call Client",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "loanType": null,
        "internalBdmUser": null,
        "omNumberOfPayments": null,
        "omPaybackAmount": null,
        "omTermDays": null,
        "omDeclineReasons": null,
        "omCollectionFrequency": null,
        "omPrincipalAmount": null,
        "omAdvanceID": null,
        "omDateFunded": null,
        "omAdvanceType": null,
        "amount": "123.00",
        "numberOfCallsMade": 0,
        "bankStatementsCreditsSenseLink": ",
        "bankStatementsUpdateLink": null,
        "sfid": null,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "applicationLink": ""
    }
}
{
  "error": "Invalid request"
}

GET - Retrieve List of Deals

Retrieve multiple deals at the same time based on the page and page size

Retrieve a list of Deals

Method: GET

Endpoint: /DEAL?page=1&pageSize=100

Headers:

Name
Value

Example Request (JavaScript - Fetch):

Example Request (cURL):

Response

Content-Type

application/json

Authorization

Bearer <API TOKEN>

curl --location 'https://bizmate.fasttask.net/api/v1/deal?page=1&pageSize=100' \
--header 'Authorization: Bearer <API TOKEN>'
const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/deal?page=1&pageSize=100", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
[
{
    "id": "id",
    "createdAt": "2024-08-08T00:20:15.867Z",
    "createdBy": "",
    "updatedAt": "2024-08-08T00:20:16.551Z",
    "updatedBy": "",
    "fields": {
        "status": "Application Received",
        "watchers": [
            {
                "type": "user",
                "id": ""
            }
        ],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "name": "Some Text",
        "customer": {
            "id": "",
            "name": "Some Text"
        },
        "callClientOrBroker": "Call Client",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "loanType": null,
        "internalBdmUser": null,
        "omNumberOfPayments": null,
        "omPaybackAmount": null,
        "omTermDays": null,
        "omDeclineReasons": null,
        "omCollectionFrequency": null,
        "omPrincipalAmount": null,
        "omAdvanceID": null,
        "omDateFunded": null,
        "omAdvanceType": null,
        "amount": "123.00",
        "numberOfCallsMade": 0,
        "bankStatementsCreditsSenseLink": ",
        "bankStatementsUpdateLink": null,
        "sfid": null,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "applicationLink": ""
    }
}, 
{
    "id": "id",
    "createdAt": "2024-08-08T00:20:15.867Z",
    "createdBy": "",
    "updatedAt": "2024-08-08T00:20:16.551Z",
    "updatedBy": "",
    "fields": {
        "status": "Application Received",
        "watchers": [
            {
                "type": "user",
                "id": ""
            }
        ],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "name": "Some Text",
        "customer": {
            "id": "",
            "name": "Some Text"
        },
        "callClientOrBroker": "Call Client",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "loanType": null,
        "internalBdmUser": null,
        "omNumberOfPayments": null,
        "omPaybackAmount": null,
        "omTermDays": null,
        "omDeclineReasons": null,
        "omCollectionFrequency": null,
        "omPrincipalAmount": null,
        "omAdvanceID": null,
        "omDateFunded": null,
        "omAdvanceType": null,
        "amount": "123.00",
        "numberOfCallsMade": 0,
        "bankStatementsCreditsSenseLink": ",
        "bankStatementsUpdateLink": null,
        "sfid": null,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "applicationLink": ""
    }
}
]
{
  "error": "Invalid request"
}