Entities

This page serves as a repository of requests and response payloads, providing a convenient reference for the seamless integration of KYC APIs. Users can access the data from this page whenever needed for different API interactions.


Company Master Data API Response

company_master_data

KeyTypeDescriptionExample
company_categorystringCompany/LLP Category is displayed. Possible values: Company limited by Shares,
Company limited by guarantee,
Unlimited company
Company limited by Shares
email_idstringEmail ID of the company/LLP[email protected]
class_of_companystringClass of company/LLP
Possible values:
Private,
Public,
One person Company
Private
date_of_last_agmstringDate of last Annual Meeting30/09/2019
registered_addressstringRegistered address of Company/LLP123, ABC LAKEVIEW TOWER OPPOSITE A COMPLEX, AHMEDABAD Ahmedabad GJ 80015 IN
registration_numberstringRegistration number of Company/LLP999999
paid_up_capital(rs)stringPaid up capital of company100000
whether_listed_or_notstringWhether company is listed or not in Stock Exchange
Possible values are:
Listed,
Unlisted
Unlisted
suspended_at_stock_exchangestringWhether a company is suspended at a stock exchange or not-
cinstringCIN of the CompanyU12300GJ2017PTC123456
company_subcategorystringSubcategory of the company
Possible values:
Union government company,
State government company, Non-government company, Subsidiary of company incorporated outside India, Guarantee and association company
Non-govt company
authorised_capital(rs)stringThe authorized capital of the company100000
company_status(for_efiling)stringEfiling status of the Company
Possible values:
Active, Dormant, Dormant Under Section 455, Active In Progress, Amalgamated, Not Available for eFiling, Converted to LLP, Converted to LLP and Dissolved, Dissolved, Under Liquidation, Liquidated, Under Process of Striking Off, Strike Off, Captured
Active
roc_codestringRegistrars of Companies (ROC)RoC-Ahmedabad
date_of_balance_sheetstringBalance Sheet Date31/03/2019
date_of_incorporationstringDate of incorporation of the Company09/06/2017
company_namestringName of the companyJOHN DOE PRIVATE LIMITED
active_compliancestring
main_division_of_business_activity_to_be_carried_out_in_indiastring74
previous_firm/_company_details,_if_applicablestring
number_of_designated_partnersstring
total_obligation_of_contributionstring0
description_of_main_divisionstringREAL ESTATE,RENTING AND BUSINESS ACTIVITIES
number_of_partnersstring
rd_regionstring
balance_sheetsarrayArray to include date_of_filing & financial_year
annual_returnsarrayArray to include date_of_filing & financial_year

llp_master_data

KeyTypeDescriptionExample
llpinstringLLPIN of the CompanyU12300GJ2017PTC123456
email_idstringEmail ID of the LLP[email protected]
registered_addressstringRegistered address of LLP123, ABC LAKEVIEW TOWER OPPOSITE A COMPLEX, AHMEDABAD Ahmedabad GJ 80015 IN
roc_codestringRegistrars of Companies (ROC)RoC-Ahmedabad
number_of_designated_partnersstring5
description_of_main_divisionstringREAL ESTATE,RENTING AND BUSINESS ACTIVITIES
date_of_incorporationstringDate of incorporation of the Company09/06/2017
total_obligation_of_contributionstring300000
llp_namestringName of the companyJOHN DOE PRIVATE LIMITED
llp_statusstringActive
main_division_of_business_activity_to_be_carried_out_in_indiastring74
previous_firm/_company_details,_if_applicablestring
number_of_partnersstring1
llp_strike_off/_amalgamated_datestring
status_under_cirpstring
rd_regionstringWestern Region
balance_sheetsarrayArray to include date_of_filing & financial_year
annual_returnsarrayArray to include date_of_filing & financial_year

director_master_data

KeyTypeDescriptionExample
designationstringDesignation of the director. Possible values:
Nominee Director|Managing Director|Additional Director|Whole-time director|Alternate Director|Director appointed in casual vacancy|Director|CEO|CFO|Manager|Company Secretary
Director
end_datestringEnd of directorship at the company-
din/panstringDIN/PAN of the director99999999
namestringName of the directorJOHN DOE
begin_datestringStart date of Directorship in the particular Company19/03/2015

charges

KeyTypeDescriptionExample
date_of_creationstring25/04/2018
date_of_modificationstring-
charge_amountstring1000000000
statusstringClosed

Director Master Data API Response

company_data

KeyTypeDescriptionExample
end_datestringEnd of directorship at the company-
company_namestringCompany the person is a director ofJOHN DOE PRIVATE LIMITED
begin_datestringStart date of Directorship in the particular Company19/03/2015
cin/fcrnstringCorporate Identification Number or Foreign Company Registration NumberU12300GJ2015PTC123456
designationstringDesignation of the director. Possible values:
Nominee Director|Managing Director|Additional Director|Whole-time director|Alternate Director|Director appointed in casual vacancy|Director|CEO|CFO|Manager|Company Secretary
Director

llp_data

KeyTypeDescriptionExample
end_datestringEnd of directorship at the company-
llp_namestringLimited Liability Partnership the person is a director ofCOOPER LLP
begin_datestringStart date of Directorship in the particular Company19/03/2024
llpin/fllpinstringLimited Liability Partnership Identification Number or Foreign Limited Liability Partnership IdentificationABC-1234
designationstringDesignation of the director. Possible values:
Nominee Director|Managing Director|Additional Director|Whole-time director|Alternate Director|Director appointed in casual vacancy|Director|CEO|CFO|Manager|Company Secretary
Director

director_data

KeyTypeDescriptionExample
dinstringDIN of the Director99999999
namestringName of the DirectorJOHN DOE

PAN Verification Basic Response

KeyTypeDescriptionExample
panstringPAN to be verifiedAAACJ1234Z
full_namestringFull name of the PAN holderJOHN DOE PRIVATE LIMITED
statusstiringStatus of the PAN: Valid or Not-ValidVALID
categorystringCategory of PAN. Possible Values: Company, Individual, HUF, Trust, Government, Body of Individuals, Association of Persons, Firm, Local Authority, Artificial Judicial PersonCompany

Verify PAN Details Response

KeyTypeDescriptionExample
panstringPAN to be verifiedXXXPX1234A
categorystringCategory of PAN. Possible Values: company, individual, huf, trust, government, body_of_individuals, association_of_persons, firm, local_authority, artificial_judicial_personindividual
statusstringStatus of the PAN. Possible values:
valid or invalid
valid
remarksstringIf an event is marked against the given in the government database. Possible values:
null,Marked as Fake,Deleted, Marked as Deactivated, Invalid PAN,Amalgamation, Acquisition,Holder is Deceased, Dissolution, Liquidated, Merger, Partition, Split, Under Liquidation
null
name_as_per_pan_matchbooleanWhether the name as per PAN given matches with the one in the government database. Possible values:
true or false
true
date_of_birth_matchbooleanWhether the date of birth given matches with the one in the government database. Possible values:
true or false
true
aadhaar_seeding_statusstringWhether the name given matches with the one in the government database. Possible values:
y, n, na
y

IFSC Verification API Response

KeyTypeDescriptionExample
BRANCH stringName of the Bank Branch.PARK STREET
CENTRE stringCentre in which the branch is situatedJAIPUR
DISTRICT stringDistrict in which the branch is situated.JAIPUR
STATE stringState in which the branch is situated.RAJASTHAN
ADDRESS stringAddress of the Branch3 PARK STREET M I ROAD M I ROAD
CONTACT stringPhone number of the branch9875003333
MICR stringNine-digit MICR code.302240007
RTGS booleanIndicates whether the branch has RTGS or not. Possible values are:
true or false
true
CITY stringCity in which the branch is situated.JAIPUR
NEFT booleanIndicates whether the branch has NEFT or not. Possible values are:
true or false
true
IMPS booleanIndicates whether the branch has NEFT or not. Possible values are:
true or false
true
BANK stringName of the BankHDFC Bank
BANKCODE stringCode the Bank.HDFC
IFSC string11-digit code of the branchHDFC0001234

Bank Account Verification [Penny-Drop] Response

KeyTypeDescriptionExample
utrstringUTR ID of the verification210219578183
account_existsbooleanIndicates if the account exists or not. Possible values: true or falsetrue
amount_depositednumIndicates the amount deposited. Possible values: 1- Only if the penny drop was successful or 0- Indicates that the account is already verified by our source and that this is a cached response.1
messagestringReturns message to know if the account was verified successfully or not.Bank Account details verified successfully
name_at_bankstringName of the account holderJohn Doe

Bank Account Verification [Penny-Less] Response

KeyTypeDescriptionExample
account_existsbooleanIndicates if the account exists or not. Possible values: true or falsetrue
name_at_bankstringName of the account holderJohn Doe
messagestringReturns message to know if the account was verified successfully or not.Bank Account details verified successfully

UPI Verification Response

ParamTypeDescriptionExample
account_existsbooleanIndicates if the account exists or not. Possible values: true or falsetrue
name_at_bankstringName of the account holderJohn Doe

Aadhaar OKYC API Response

Generate OTP

KeyTypeDescriptionExample
reference_idstringID to be used when calling Aadhaar OKYC Verify OTP API10683915
messagestringStatus of OTP generationOTP sent successfully

Verify OTP

KeyTypeDescriptionExample
reference_idstringThe reference ID you have received in the Aadhaar Generate OTP API1234567
statusstringAadhaar Exists or not possible values are:
VALID or INVALID
valid
messagestringMessage for the status of APIAadhaar Card Exists
care_ofstringRelationship details of the Aadhaar Holder.S/O: Johnny Doe
dobstringDate of Birth of the Aadhaar Holder123456789012
full_addressstringAddress of the Aadhaar HolderMain Cross 3rd,Bengaluru,Karnataka
email_hashstringHashed email of Aadhaar Holder044917e2c4c62a439d068.......d9f71bbde10b
genderstringGender of the Aadhaar HolderM
namestringName of the Aadhaar HolderJohn Doe
year_of_birthstringYear of Birth of Aadhaar Holder1985
mobile_hashstringHashed Mobile Number of Aadhaar Holder044917e2c4c62a439d068.......d9f71bbde10b1d227a914e
photostringHashed Photo Link of Aadhaar Holderdata:image/jpeg;base64,/9j/4AAQSk.......mj/2Q==
share_codestringShare code9999
addressobjectSplit Address of the Aadhaar HolderLook Below

address

KeyTypeDescriptionExample
countrystringCountry of the Aadhaar HolderIndia
districtstringDistrict of the Aadhaar HolderBengaluru
housestringHouse addressMangal Kanaka Niwas
landmarkstringLandmark address-
pincodestringPincode of the Aadhaar Holder581615
post_officestringPost officeBengaluru
statestringState of the Aadhaar HolderKarnataka
streetstringStreet addressMain Cross 3rd
subdistrictstringSub District-
vtcstringVillage, Town, City(VTC)Bengaluru

MSME Udyam Number Verification


KeyTypeDescriptionExample
udyam_registration_numberstringUdyam Registration NumberUDYAM-GJ-01-0233352
name_of_enterprisestringRegistered name of MSMEWayne Enterprise
major_activitystringMajor activity of unit(s)/plant; Possible values - Services , Manufacturing, and TradingServices
organisation_typestringType of organisation; Possible values - Private Limited, Proprietary, Partnership, Public LimitedPrivate Limited
social_categorystringSocial category of the owner; Possible values - General, SC, ST, and OBCGeneral
date_of_incorporationstringDate on which MSME was incorporated16/01/2023
date_of_commencementstringDate of commencement16/01/2023
district_industries_centerstringDistrict industry center (DIC)Ahmedabad
msme_dfostringDevelopment and Facilitation office (DFO)Ahmedabad
date_of_udyam_registrationstringDate of MSME registration25/01/2023
enterprise_classificationsobjectList of MSME classificationLink Below
registered_addressobjectThe official registered address of enterpriseLink Below
plant_locationsobjectLocation details of registeredLink Below
nic_codesobjectList of National industrial classification (NIC) codes based on the activities performed by this enterpriseLink Below

enterprise_classifications


KeyTypeDescriptionExample
yearstringFinancial year for which the classification is effective
typestringEnterprise type; Possible values - Micro, Medium, and Small
datestringClassification date

registered_address


KeyTypeDescriptionExample
flatstringPlot/Block numberA-100
buildingstringName of Premises/ BuildingLakeview Tower
townstringTown nameAhmedabad
blockstringBlock nameA Block
streetstringStreet addressVastrapur
citystringCity where enterprise is presentAhmedabad
statestringState where enterprise is presentGujarat
pinnumPin code of enterprise380015
districtstringDistrict where enterprise is presentAhmedabad
masked_mobilenumMobile number of the enterprise owner93*250
emailstringMasked email of the enterprise owner[email protected]

plant_locations


KeyTypeDescriptionExample
unit_namestringName of unitWayne Enterprise
flatstringFlat numberA-100
buildingstringBuilding name of plantLakeview Tower
townstringTown where plant is locatedAhmedabad
blockstringblock of plant locationA Block
streetstringstreet nameVastrapur
citystringCity where unit is presentAhmedabad
statestringState where unit is presentGujarat
pinnumPin code of plant380015
districtstringDistrict where unit is presentAhmedabad

nic_codes


KeyTypeDescriptionExample
two_digit_codestringtwo digit national industrial classification number and description63 - Information service activities
four_digit_codestringfour digit national industrial classification number and description6399 - Other information service activities n.e.c.
five_digit_codestringfive digit national industrial classification number and description63999 - Other information service activities n.e.c.
activitystringType of activityServices
datestringDate25-01-2023