List Investors by Date Range

6 min

We can fetch the number of investors created by customers based on the status of the investor. We can get the list of investors with the following data: has the investor logged in, has the investor filled any of the forms and saved them, and has the investor submitted the application based on the criteria provided in the API request.

Sending Requests

For sending requests the hostname and protocol will be the same as given in the Authentication section.

Send a post request to: /api/pullmerchants/dateRange with the data as below.

Headers

Property	Value
Content-type	application/json
Authorization	Authorisation header as per the login request

Request Body

{
    "customerId": "...customerId...",
    "from": 1600882436,
    "to": 1601055236,
    "status":"pending"
}

The below table describes all the properties available in the request body:

Property	Accepted Values/Format	Description
customerId	String	customerId of that customer
from	Integer	timestamp, that you want to fetch from the date
to	Integer	timestamp, that you want to fetch till the date
status	string	Status of investor wanted to be pulled (all/pending/accepted/rejected/draft/redo)

Expected Response

{
    "results": [
        {
            "merchantId": "..merchant id..",
            "customerId": "..customer id..",
            "status": "pending",
            "applicationSubmitted": true,
            "hasLoggedIn": true,
            "hasFilledForm": true
        },
        {
            "merchantId": "..merchant id..",
            "customerId": "..customer id..",
            "status": "pending",
            "applicationSubmitted": true,
            "hasLoggedIn": true,
            "hasFilledForm": true
        }
    ]
}

The below table describes the properties that are returned in the request:

Parameters	Accepted Values/Format	Description
merchantId	String	Investor Onboarding corresponding merchant id
customerId	String	Investor Onboarding corresponding customer id
status	String	Status of the investor
applicationSubmitted	Boolean	Has investor submitted
hasLoggedIn	Boolean	Has the investor Logged In
hasFilledForm	Boolean	Has the investor Filled out the form

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].