GetCIN
Overview

A valid Company CIN is mandatory to make an InstaAPI call. Hence, if you don’t have CIN in your existing database to query for the data directly, you can enable the user to search by company name or PAN to get the relevant CIN. Once the CIN is fetched, you can make an API call using the CIN.

GetCIN service enables you to get the accurate CIN number of the company. You can get company CIN by using any valid company name or valid company PAN. You can query for company names using two modes, 1. Starts With 2. Contains.

  • Create an account in InstaFinancials.com website
  • Generate API Key
  • Use the API key to integrate with any custom application
Documentation

[GET] GetCIN

Returns data about company based on given search string company PAN.

  • URI Structure

    • Search By Name :

      /GetCIN/{APIVersion}/{ResponseType}/Search/{SearchString}/Mode/{SearchMode}

      Example: /GetCIN/v1/json/Search/cbl data scie/Mode/nc

    • Search By PAN :

      /GetCIN/{APIVersion}/{ResponseType}/Search/CompanyPAN{CompanyPAN}

      Example: /GetCIN/v1/json/Search/CompanyPAN/{CompanyPAN}

      /GetCIN/V1/JSON/Search/CompanyPAN/AAACD0764H
  • Method:

    GET

  • URI Params

    1. {APIVersion} : Version of API (v1)
    2. {ResponseType} : Response Type (JSON/XML)
    3. {SearchString} : 3 or more characters of company name search string
    4. {SearchMode} : Company name search modes (SW/NC) *SW = SearchWith and *NC = NameContains
    5. {CompanyPAN} : Valid Company PAN
  • Data Params

    None

  • Headers

    user-key:{userIdentificationKey}

  • Success Response:

    • Code: 200
    • Data:{Response}
  • Error Response:

    Data Key Data Type Data Description
    Status String Error
    Type String Self Descriptive expression.

    Self Descriptive expression:

    Type Error Action
    Unknown Error Undefined Error Contact to admin
    Invalid Prams Unrecognized Parameter Change Parameter
    Invalid Response Type Unrecognized Response Type Change Response Type
    Invalid Cin CIN not found Verify CIN
    Invalid Search Mode Unrecognized Search mode Change your Search mode
    Processing Error Undefined Error Contact to admin
    Load Error Error in loading data Retry
    Invalid uri Unrecognized URI Change URI
    Unauthenticated Unrecognized user-key or header Add valid user-key or header
  • Response/Output: (Top 10 results)

    Data Key Data Type Data Description
    CompanyCin String CIN of company, as per MCA
    CompanyName String Complete Legal Name of Company
    CompanyFullAddress String Registered address of company, as per MCA Records
    InstaFinancialsLink String URL of InstaFinancials to get more information about company
  • Sample Call:

    $.ajax({
        url: "/GetCIN/v1/json/Search/cbl data scie/Mode/nc",
        headers: { 'user-key': 'xxxxxxxxxxxxxxxxxxxx' },
        dataType: "json",
        type : "GET",
        success : function(r) { console.log(r); }
    });
Resources

Coming soon!

API Demo (Sandboxed)
  • Search By Name
    /GetCIN/ / /Search/ /MODE/
    Generated URI : /GetCIN/{{D1.Version}}/{{D1.ResponseType}}/Search/{{D1.SearchString}}/MODE/{{D1.SearchMode}}
    Generated CALL :
    $.ajax({
        url: "/GetCIN/{{D1.Version}}/{{D1.ResponseType}}/Search/{{D1.SearchString}}/MODE/{{D1.SearchMode}}",
        headers: { 'user-key': 'xxxxxxxxxxxxxxxxxxxx' },
        dataType: "json",
        type : "GET",
        success : function(r) { console.log(r); }
    });
    Generated Response:
    {{D1.SampleData}}
  • Search By PAN
    /GetCIN/ / /Search/CompanyPAN
    Generated URI : /GetCIN/{{D2.Version}}/{{D2.ResponseType}}/Search/CompanyPAN/{{D2.PAN}}
    Generated CALL :
    $.ajax({
        url: "/GetCIN/{{D2.Version}}/{{D2.ResponseType}}/Search/CompanyPAN/{{D2.PAN}}",
        headers: { 'user-key': 'xxxxxxxxxxxxxxxxxxxx' },
        dataType: "json",
        type : "GET",
        success : function(r) { console.log(r); }
    });
    Generated Response:
    {{D2.SampleData}}
Downloads

Coming soon!