API Reference

Crime Check Company

Response Field Description

FieldTypeDescription
statuscodeIntegerHTTP-like custom response code indicating success (200 = OK).
statusBooleanTrue if transaction was successful
messageStringProvides a descriptive message about the API operation. Here, it confirms that the individual record has been successfully submitted and advises to download the report after some time
requestIdStringA unique identifier assigned to this specific API request. It can be used to track or verify the request in system logs.
reference_idInteger/StringA unique internal reference number generated by the system for this transaction. It’s generally used to fetch the corresponding report or status later.


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
Language
Click Try It! to start a request and see the response here!