Probe API - Data Update Mechanism
Probe API - Data Update Mechanism
API
www.probeinformation.com
Probe API: Data Update Mechanism
Probe provides control over data freshness to users. Every data object returned via Probe API
comes with a date-stamp – the date at which the data for the company was last updated.
After reviewing this date-stamp, if the user is not satisfied with the freshness of the data, a
data update request can be made.
A data update request will trigger a series of automated and manual workflows to gather and
cleanse the data for the company from various data sources and load it into Probe’s database.
The user may proceed to fetch the data once the update process is completed.
What are the different types of data update requests that can be made?
The data on any company is grouped into 2 categories: “Base” and “Comprehensive”.
1. Base data includes basic company overview details, details on directors, and charges.
2. Comprehensive covers all the data available for a company including the Base data.
There are separate data update processes for base and comprehensive data, with different
turnaround times. A base data update on a company will typically complete in less than a
minute. A comprehensive data update on a company will typically complete in 3 to 4 business
hours.
This is left to the discretion of the users; we recommend that users consider factors such as
business requirements, the underlying nature of the data sources, and operations constraints,
while programming their data update frequencies. As a thumb-rule, base data updates can
be done twice a month, whereas comprehensive data updates can be done twice a year. Note
that company filings take place only once a year, so multiple update requests in a short span
of time will be unnecessary. Also note that our database is common across all our users – an
update request triggered by any user will update the common database; the updated data
will then be available to our entire user base.
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
2
API
www.probeinformation.com
What is the process for updating Base data on a company?
Before making a Base Details API call for a company, first invoke Data Status API, passing in the
CIN or PAN. The API response will contain the field “last_base_updated” – this is the date at which
the base data for that company was last updated in Probe’s Database, this date can be used to
determine whether a fresh update of base data is required or not.
1. Invoke the Update Base Details API method, passing in the CIN or PAN along with the Call
Back URL. A request_id will be returned. Store this.
2. The status of the update request will be posted back to the URL provided by the user once
the request is fulfilled. The parameter name is “postback_url” and the entire path must
be passed on including http/s and port information.
3. Proceed to invoke the Base Details API upon getting the status as ‘FULFILLED’.
last_base_updated
POST /probe_pro_sandbox/companies/{CinOrPan}/update-basedata
POST /probe_pro_sandbox/llps/{LlpinOrPan}/update-basedata
If Yes – REQUEST AN UPDATE
postback_url
Update Base Details API Data Update
Required?
Request ID
Note: The status of the update will be
posted back to the URL provided by client
Typically takes less than a minute
once the update request is fulfilled.
If No - FETCH INSTANTLY
CALL BACK from Probe "cin": "string",
"request_id": "string",
WHITELIST
Sandbox: sandbox.postback.api.probe42.in "status": "FULFILLED"
Production: postback.api.probe42.in GET /probe_pro_sandbox/companies/{CinOrPan}/base-details
GET /probe_pro_sandbox/llps/{LlpinOrPan}/base-details
Once the update request is complete, our API will do a POST to this “postback_url” passed on by
the client. In case of errors, it will be attempted for 3 times. Necessary firewall changes to accept
the POST request must be in place for this to work.
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
3
API
www.probeinformation.com
What is the process for updating Comprehensive data on a company?
Before making a Comprehensive data API call for a company, first invoke the Data Status API,
passing in the CIN or PAN. This will return the following 2 fields:
1. last_fin_year_end: the latest financial year for which filings are available for this company
in Probe’s database.
2. last_details_updated: the date at which the comprehensive data on this company was
last updated in Probe’s database. Always request for an update if it is “null”.
These 2 fields can be used to determine whether a fresh update of comprehensive data is
required. If an update is deemed necessary:
1. Invoke the Update Comprehensive Details API method, passing in the CIN or PAN along
with the Call Back URL. A “request_id” will be returned. Store this.
2. The status of the update request will be posted back to the URL provided by the user once
the request is “fulfilled”. The parameter name is “postback_url” and the entire path must
be passed on including http/s and port information.
3. Proceed to invoke the Comprehensive Details API upon getting the status as “FULFILLED”.
last_fin_year_end last_details_updated
POST/probe_pro_sandbox/companies/{CinOrPan}/update
POST/probe_pro_sandbox/llps/{LlpinOrPan}/update If Yes – REQUEST AN UPDATE
postback_url
Update Comprehensive API Data Update
Required?
Request ID
Note: The status of the update will be
posted back to the URL provided by client
Typically, takes 4 working hours once the update request is fulfilled.
CALL BACK from Probe "cin": "string", If No - FETCH INSTANTLY
WHITELIST "request_id": "string",
Sandbox: sandbox.postback.api.probe42.in "status": "FULFILLED"
Production: postback.api.probe42.in
Once the update request is complete, our API will do a POST to Input client_name as “________________”
this “postback_url” passed on by the client. In case of errors, it
will be attempted for 3 times. Necessary firewall changes to Comprehensive Details API (PDF)
accept the POST request must be in place for this to work.
GET/probe_reports_sandbox/companies/{cin}/reports
GET/probe_reports_sandbox/llps/{LlpinOrPan}/reports
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
4
API
www.probeinformation.com
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
5
API
www.probeinformation.com
What is the process for updating Base data on a company?
Alternatively, the status of the “Base update” can also be checked using the Get Update Status
API by following the below steps:
1. Invoke the Update Base Details API method, passing in the CIN or PAN.
2. A request_id will be returned. Store this.
3. Wait for 1 Minute.
4. Call the Get Update Status API, passing in the request_id.
5. Check the returned field “status”.
a. If status is ‘FULFILLED’, proceed to invoke the Base Details API.
b. Else, return to step 3
last_base_updated
POST /probe_pro_sandbox/companies/{CinOrPan}/update-basedata
POST /probe_pro_sandbox/llps/{LlpinOrPan}/update-basedata
If Yes – REQUEST AN UPDATE
If No - FETCH INSTANTLY
Wait for 1 Minute
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
6
API
www.probeinformation.com
What is the process for updating Comprehensive data on a company?
Alternatively, the status of the “Comprehensive update” can also be checked using the Get
Update Status API by following the below steps. If an update is deemed necessary:
1. Invoke the Update Comprehensive API method, passing in the CIN or PAN.
2. A request_id will be returned. Store this.
3. Wait for 2 hours.
4. Call the Get Update Status API, passing in the request_id.
5. Check the returned field status.
a. If status is ‘FULFILLED’, proceed to invoke the Comprehensive API.
b. Else, return to step 3
The below flowchart shows the process that can be followed:
last_details_updated last_fin_year_end
Request ID
If No - FETCH INSTANTLY
Wait for 2 Hours
If Company is “In-Active”
Cancelled END
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
7
API
I. Incorporation Documents:
The comprehensive details API (JSON) will return a document id (field name: 'doc_id') under
the financials or nbfc_financials and shareholdings_summary sections respectively. Pick the
unique doc_ids from the JSON output and make a call to the Reference Document by ID API
to pull the documents.
• Form AOC-4: The comprehensive details API for a company will return a document id
(field name: 'doc_id') under the financials or nbfc_financials (bs > metadata) section.
• LLP Form No 8: The comprehensive details API for an LLP will return a document id (field
name: 'doc_id') under the financials (statement_of_assets_and_liabilities > metadata)
section.
✓ Pick the unique 2 doc ids from the respective sections of Comprehensive API output and
make a call to the Reference Document by ID API.
• Form MGT-7: The comprehensive details API for a company will also return a document
id (field name: 'doc_id') under the shareholdings_summary (metadata) section.
• Form No 11: The comprehensive details API for an LLP will also return a document id (field
name: 'doc_id') under the contribution_details (metadata) section.
✓ Pick the doc id from the respective sections of comprehensive API JSON output and make
a call to the Reference Document by ID API.
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited
8
API
The below flowchart shows the process for fetching Reference Documents:
bs bs
doc_id doc_id doc_id
Comprehensive Details API (PDF) Latest Year Previous Year Latest Year
GET/probe_reports_sandbox/companies/{cin}/reports
GET/probe_reports_sandbox/llps/{LlpinOrPan}/reports AOC-4 AOC-4 MGT-7
Financial Documents
Incorporation Document API • Financial Statements (Form AOC-4)
• Annual Return (Form MGT-7)
• Memorandum of Association (MOA)
• Articles of Association (AOA)
• Certificate of Incorporation (COI) GET /probe_reports_sandbox/companies/{CinOrPan}/reference-document-by-id
GET /probe_reports_sandbox/llps/{LlpinOrPan}/reference-document-by-id
GET /probe_reports_sandbox/companies/{CinOrPan}/reference-document
GET /probe_reports_sandbox/llps/{LlpinOrPan}/reference-document
Avoid Fetching the same data / document multiple times as it will have commercial implications.
CONFIDENTIAL
The information contained in these documents is confidential, privileged and only for the information of the intended recipient and may not be used, published or redistributed without the prior written consent of
Probe Information Services Private Limited