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

Key	Type	Description	Example
company_category	string	Company/LLP Category is displayed. Possible values: `Company limited by Shares`, `Company limited by guarantee`, `Unlimited company`	Company limited by Shares
email_id	string	Email ID of the company/LLP	[email protected]
class_of_company	string	Class of company/LLP Possible values: `Private`, `Public`, `One person Company`	Private
date_of_last_agm	string	Date of last Annual Meeting	30/09/2019
registered_address	string	Registered address of Company/LLP	123, ABC LAKEVIEW TOWER OPPOSITE A COMPLEX, AHMEDABAD Ahmedabad GJ 80015 IN
registration_number	string	Registration number of Company/LLP	999999
paid_up_capital(rs)	string	Paid up capital of company	100000
whether_listed_or_not	string	Whether company is listed or not in Stock Exchange Possible values are: Listed, Unlisted	Unlisted
suspended_at_stock_exchange	string	Whether a company is suspended at a stock exchange or not	-
cin	string	CIN of the Company	U12300GJ2017PTC123456
company_subcategory	string	Subcategory 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)	string	The authorized capital of the company	100000
company_status(for_efiling)	string	Efiling 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_code	string	Registrars of Companies (ROC)	RoC-Ahmedabad
date_of_balance_sheet	string	Balance Sheet Date	31/03/2019
date_of_incorporation	string	Date of incorporation of the Company	09/06/2017
company_name	string	Name of the company	JOHN DOE PRIVATE LIMITED
active_compliance	string
main_division_of_business_activity_to_be_carried_out_in_india	string		74
previous_firm/_company_details,_if_applicable	string
number_of_designated_partners	string
total_obligation_of_contribution	string		0
description_of_main_division	string		REAL ESTATE,RENTING AND BUSINESS ACTIVITIES
number_of_partners	string
rd_region	string
balance_sheets	array	Array to include `date_of_filing` & `financial_year`
annual_returns	array	Array to include `date_of_filing` & `financial_year`

llp_master_data

Key	Type	Description	Example
llpin	string	LLPIN of the Company	U12300GJ2017PTC123456
email_id	string	Email ID of the LLP	[email protected]
registered_address	string	Registered address of LLP	123, ABC LAKEVIEW TOWER OPPOSITE A COMPLEX, AHMEDABAD Ahmedabad GJ 80015 IN
roc_code	string	Registrars of Companies (ROC)	RoC-Ahmedabad
number_of_designated_partners	string		5
description_of_main_division	string		REAL ESTATE,RENTING AND BUSINESS ACTIVITIES
date_of_incorporation	string	Date of incorporation of the Company	09/06/2017
total_obligation_of_contribution	string		300000
llp_name	string	Name of the company	JOHN DOE PRIVATE LIMITED
llp_status	string		Active
main_division_of_business_activity_to_be_carried_out_in_india	string		74
previous_firm/_company_details,_if_applicable	string
number_of_partners	string		1
llp_strike_off/_amalgamated_date	string
status_under_cirp	string
rd_region	string		Western Region
balance_sheets	array	Array to include `date_of_filing` & `financial_year`
annual_returns	array	Array to include `date_of_filing` & `financial_year`

director_master_data

Key	Type	Description	Example
designation	string	Designation 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_date	string	End of directorship at the company	-
din/pan	string	DIN/PAN of the director	99999999
name	string	Name of the director	JOHN DOE
begin_date	string	Start date of Directorship in the particular Company	19/03/2015

charges

Key	Type	Example
date_of_creation	string	25/04/2018
date_of_modification	string	-
charge_amount	string	1000000000
status	string	Closed

Director Master Data API Response

company_data

Key	Type	Description	Example
end_date	string	End of directorship at the company	-
company_name	string	Company the person is a director of	JOHN DOE PRIVATE LIMITED
begin_date	string	Start date of Directorship in the particular Company	19/03/2015
cin/fcrn	string	Corporate Identification Number or Foreign Company Registration Number	U12300GJ2015PTC123456
designation	string	Designation 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

Key	Type	Description	Example
end_date	string	End of directorship at the company	-
llp_name	string	Limited Liability Partnership the person is a director of	COOPER LLP
begin_date	string	Start date of Directorship in the particular Company	19/03/2024
llpin/fllpin	string	Limited Liability Partnership Identification Number or Foreign Limited Liability Partnership Identification	ABC-1234
designation	string	Designation 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

Key	Type	Description	Example
din	string	DIN of the Director	99999999
name	string	Name of the Director	JOHN DOE

PAN Verification Basic Response

Key	Type	Description	Example
pan	string	PAN to be verified	AAACJ1234Z
full_name	string	Full name of the PAN holder	JOHN DOE PRIVATE LIMITED
status	stiring	Status of the PAN: Valid or Not-Valid	VALID
category	string	Category of PAN. Possible Values: `Company`, `Individual`, `HUF`, `Trust`, `Government`, `Body of Individuals`, `Association of Persons`, `Firm`, `Local Authority`, `Artificial Judicial Person`	Company

Verify PAN Details Response

Key	Type	Description	Example
pan	string	PAN to be verified	XXXPX1234A
category	string	Category of PAN. Possible Values: `company`, `individual`, `huf`, `trust`, `government`, `body_of_individuals`, `association_of_persons`, `firm`, `local_authority`, `artificial_judicial_person`	individual
status	string	Status of the PAN. Possible values: `valid` or `invalid`	valid
remarks	string	If 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_match	boolean	Whether the name as per PAN given matches with the one in the government database. Possible values: `true` or `false`	true
date_of_birth_match	boolean	Whether the date of birth given matches with the one in the government database. Possible values: `true` or `false`	true
aadhaar_seeding_status	string	Whether aadhaar is linked with this PAN or not. Possible values: `y`, `n`, `na`	y

IFSC Verification API Response

Key	Type	Description	Example
BRANCH	string	Name of the Bank Branch.	PARK STREET
CENTRE	string	Centre in which the branch is situated	JAIPUR
DISTRICT	string	District in which the branch is situated.	JAIPUR
STATE	string	State in which the branch is situated.	RAJASTHAN
ADDRESS	string	Address of the Branch	3 PARK STREET M I ROAD M I ROAD
CONTACT	string	Phone number of the branch	9875003333
MICR	string	Nine-digit MICR code.	302240007
RTGS	boolean	Indicates whether the branch has RTGS or not. Possible values are: true or false	true
CITY	string	City in which the branch is situated.	JAIPUR
NEFT	boolean	Indicates whether the branch has NEFT or not. Possible values are: true or false	true
IMPS	boolean	Indicates whether the branch has NEFT or not. Possible values are: true or false	true
BANK	string	Name of the Bank	HDFC Bank
BANKCODE	string	Code the Bank.	HDFC
IFSC	string	11-digit code of the branch	HDFC0001234

Bank Account Verification [Penny-Drop] Response

Key	Type	Description	Example
utr	string	UTR ID of the verification	210219578183
account_exists	boolean	Indicates if the account exists or not. Possible values: `true` or `false`	true
amount_deposited	num	Indicates 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
message	string	Returns message to know if the account was verified successfully or not.	Bank Account details verified successfully
name_at_bank	string	Name of the account holder	John Doe

Bank Account Verification [Penny-Less] Response

Key	Type	Description	Example
account_exists	boolean	Indicates if the account exists or not. Possible values: `true` or `false`	true
name_at_bank	string	Name of the account holder	John Doe
message	string	Returns message to know if the account was verified successfully or not.	Bank Account details verified successfully

UPI Verification Response

Param	Type	Description	Example
account_exists	boolean	Indicates if the account exists or not. Possible values: `true` or `false`	true
name_at_bank	string	Name of the account holder(Masked)	JXXXXe

Aadhaar OKYC API Response

Generate OTP

Key	Type	Description	Example
reference_id	string	ID to be used when calling Aadhaar OKYC Verify OTP API	10683915
message	string	Status of OTP generation	OTP sent successfully

Verify OTP

Key	Type	Description	Example
reference_id	string	The reference ID you have received in the Aadhaar Generate OTP API	1234567
status	string	Aadhaar Exists or not possible values are: VALID or INVALID	valid
message	string	Message for the status of API	Aadhaar Card Exists
care_of	string	Relationship details of the Aadhaar Holder.	S/O: Johnny Doe
dob	string	Date of Birth of the Aadhaar Holder	123456789012
full_address	string	Address of the Aadhaar Holder	Main Cross 3rd,Bengaluru,Karnataka
email_hash	string	Hashed email of Aadhaar Holder	044917e2c4c62a439d068.......d9f71bbde10b
gender	string	Gender of the Aadhaar Holder	M
name	string	Name of the Aadhaar Holder	John Doe
year_of_birth	string	Year of Birth of Aadhaar Holder	1985
mobile_hash	string	Hashed Mobile Number of Aadhaar Holder	044917e2c4c62a439d068.......d9f71bbde10b1d227a914e
photo	string	Hashed Photo Link of Aadhaar Holder	data:image/jpeg;base64,/9j/4AAQSk.......mj/2Q==
share_code	string	Share code	9999
address	object	Split Address of the Aadhaar Holder	Look Below

address

Key	Type	Description	Example
country	string	Country of the Aadhaar Holder	India
district	string	District of the Aadhaar Holder	Bengaluru
house	string	House address	Mangal Kanaka Niwas
landmark	string	Landmark address	-
pincode	string	Pincode of the Aadhaar Holder	581615
post_office	string	Post office	Bengaluru
state	string	State of the Aadhaar Holder	Karnataka
street	string	Street address	Main Cross 3rd
subdistrict	string	Sub District	-
vtc	string	Village, Town, City(VTC)	Bengaluru

PAN-Aadhaar Link Status Response

Key	Type	Description	Example
aadhaar_seeding_status	string	Whether the mentioned PAN and Aadhaar are linked with each other. Possible values: `y`, `n`	y
message	string	Link status description	Your PAN is linked to Aadhaar Number XXXX XXXX 9999

MSME Udyam Number Verification

Key	Type	Description	Example
udyam_registration_number	string	Udyam Registration Number	UDYAM-GJ-01-0233352
name_of_enterprise	string	Registered name of MSME	Wayne Enterprise
major_activity	string	Major activity of unit(s)/plant; Possible values - `Services` , `Manufacturing`, and `Trading`	Services
organisation_type	string	Type of organisation; Possible values - `Private Limited`, `Proprietary`, `Partnership`, `Public Limited`	Private Limited
social_category	string	Social category of the owner; Possible values - `General`, `SC`, `ST`, and `OBC`	General
date_of_incorporation	string	Date on which MSME was incorporated	16/01/2023
date_of_commencement	string	Date of commencement	16/01/2023
district_industries_center	string	District industry center (DIC)	Ahmedabad
msme_dfo	string	Development and Facilitation office (DFO)	Ahmedabad
date_of_udyam_registration	string	Date of MSME registration	25/01/2023
enterprise_classifications	object	List of MSME classification	Link Below
registered_address	object	The official registered address of enterprise	Link Below
plant_locations	object	Location details of registered	Link Below
nic_codes	object	List of National industrial classification (NIC) codes based on the activities performed by this enterprise	Link Below

enterprise_classifications

Key	Type	Description
year	string	Financial year for which the classification is effective
type	string	Enterprise type; Possible values - Micro, Medium, and Small
date	string	Classification date

registered_address

Key	Type	Description	Example
flat	string	Plot/Block number	A-100
building	string	Name of Premises/ Building	Lakeview Tower
town	string	Town name	Ahmedabad
block	string	Block name	A Block
street	string	Street address	Vastrapur
city	string	City where enterprise is present	Ahmedabad
state	string	State where enterprise is present	Gujarat
pin	num	Pin code of enterprise	380015
district	string	District where enterprise is present	Ahmedabad
masked_mobile	num	Mobile number of the enterprise owner	93*250
email	string	Masked email of the enterprise owner	[email protected]

plant_locations

Key	Type	Description	Example
unit_name	string	Name of unit	Wayne Enterprise
flat	string	Flat number	A-100
building	string	Building name of plant	Lakeview Tower
town	string	Town where plant is located	Ahmedabad
block	string	block of plant location	A Block
street	string	street name	Vastrapur
city	string	City where unit is present	Ahmedabad
state	string	State where unit is present	Gujarat
pin	num	Pin code of plant	380015
district	string	District where unit is present	Ahmedabad

nic_codes

Key	Type	Description	Example
two_digit_code	string	two digit national industrial classification number and description	63 - Information service activities
four_digit_code	string	four digit national industrial classification number and description	6399 - Other information service activities n.e.c.
five_digit_code	string	five digit national industrial classification number and description	63999 - Other information service activities n.e.c.
activity	string	Type of activity	Services
date	string	Date	25-01-2023