API Reference

Crime Check Company

Log in to see full request history

Format of optional directors JSON array

(only name is mandatory, others will increase relevance of results):


[ { "name" : "...", // Mandatory "fatherName" : "", "dob" : "...", "address" : "...", "panNumber" : "" } ]

Possible values of companyType


DescriptionValue
Private LimitedPvtLtd
Public LimitedLimited
Limited Liability CompanyLLC
Limited Liability PartnershipLLP
Registered FirmRegFirm
Unregistered FirmUnregFirm
ProprietaryProprietary
Don't Knowdontknow
Body Params
string
required

Name of the company

string

Optional for Default/Detailed Reports Mandatory for realTimeHighAccuracy Type of the company. See below for possible options.

string

Registered address of the company

string

Director(s)/Owner(s)/Partner(s) of the company Each object in the array represents one individual (see below)

string

If the value realTimeHighAccuracy is passed, generates a Real-time report, compiling all cases returned by highAccuracy mode of Crime Records API. Report will be available in next few mins. There is no manual scrutiny by legal team. If no value is passed, report generation will happen through usual process of filtering by CrimeCheck's operations team, including manual scrutiny by legal team. Report will be available in agreed TAT (4 - 24 hours usually). If realTimeHighAccuracy mode is set, then companyType is mandatory.

string

CIN Number of the company

string

GST Number of Company

string

Any string tag you want to attach to this request. E.g. "Agri Loan", "Auto Loan"

string

Slab of the monetary value to be delivered to the assessee, based on this request's risk profile. Will be used to determine the risk, comparing with the kind of cases the assessee is involved in. Possible values are: 0 - 1 Lakh ₹, 1 - 10 Lakh ₹, More than 10 lakh ₹

string

If set to true, we'll monitor this profile at a regular frequency for any new cases or updates to existing cases, and send you updated reports via callback. The CrimeWatch callback body will have crimewatch key set to true to indicate that it is a CrimeWatch response. It'll also have an additional crimewatch object inside each case object, which has a flag field indicating the nature of change from previous report (new,modified,nochange), followed by a modified_fields array listing the fields that were changed if any.

Headers
string
required
string
Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json