Client Profile

PURPOSE

The API call provides basic personal details of the client in the response. By passing only client code in the request along with API keys, client will be able to fetch account related personal details including name, date of birth, account activation date, PAN, account type (savings or current), account nominee name, address, bank details associated with demat account, mobile number and email id.

Request URL

https://dataservice.iifl.in/openapi/prod/BackoffClientProfile

Request Method: POST

Request format: JSON

Request Header:

Content-Type: application/json

Ocp-Apim-Subscription-Key:
to be provided after registration

REQUEST BODY

HEADER

Field Name	Description	Data Type (max length)	Validation	Sample Value
appName	App Name provided at the time of registration	String	Cannot be empty.	IIFLMarDEMO
appVer	Developer App Version	String	Cannot be empty.	1.0
key	UserKey generated at the time of registration	String	Cannot be empty.	ABpyyGUh1nsbesSlup3VKURkI4tQDe8y
osName	Channel of order	String	Cannot be empty.	WEB, Android, iOS
requestCode	Request Code of the API called	String	Cannot be empty.	IIFLMarRQBackoffClientProfile
userId	User ID generated at the time of registration	String	Cannot be empty.	ZkhghN5uKj
password	Password generated at the time of registration	String	Cannot be empty.	lfjnfS7rHGj

BODY

Field Name	Description	Data Type (max length)	Validation	Sample Value
ClientCode	This the clientcode of particular client	String (8)	Cannot be empty	S0002

REQUEST:

{
  "head": {
    "appName": "IIFLMarDEMO",
    "appVer": "1.0",
    "key": "ABpyyGUh1nsbesSlup3VKURkI4tQDe8y",
    "osName": "Android",
    "requestCode": "IIFLMarRQBackoffClientProfile",
    "userId": "mocZueK622W",
    "password": "UjR1ElLwSzr"
  },
  "body": {
    "ClientCode": "Dummy"
  }
}

RESPONSE BODY

HEADER

Field Name	Description	Data Type (max length)	List of Values	Sample Value
responseCode	This is the response code of API	String	-	IIFLMarRPBackoffClientProfile
status	This is the response code of API	String	0 – Success 2 – Invalid Head Parameters	0
statusDescription	This is the response code of API	String	0 - Success 2 - Invalid head parameters	Success

BODY

Field Name	Description	Data Type (max length)	List Values	Sample Value
Status	Returns the status of the response.	Int	0-Success 1-No data found 2-Not a valid parameter -1-Issue while process your request on Server 9-Invalid Session -2-403 : Access denied	0
Message	Returns the message of the response.	String	A. Invalid Input Parameters B. Success C. No record found D. 403 : Access denied E. Invalid Session	Success
ClientCode	This is the client login ID	String (8)		Dummy123
ClientName	It the client name	String(100)	-	Dummy Name
DOB	It is the client date of birth	String(8)	-	19980101
ActivationDate	Client profile activation date	String(8)	-	20190101
Pan	Client PAN Number	String(20)	-	AXXXX0000X
AccountType	S - Saving C - Current	String(1)	S - Saving C - Current	S
NomineeName	Name of the nominee of the account	String(45)	-	Dummy Nominee
PermanentAddress	Client address	String(350)	-	ABC Apartment
CorrespondenceAddress	Client address	String(350)	-	ABC Apartment
PINCode	Client address code	String(10)	-	S0002
State	Client state name	String(30)	-	RAJASTHAN
BankAccountNumber	Account number of the client’s bank	String(20)	-	00XXXXXXXX
BankIFSC	IFSC code of the client’s bank	String(20)	-	XYZ0000062
BankName	Client bank name	String(100)	-	XYZBANK LTD
Mobile	Client mobile number	String(30)	-	9998887770
Email	Client mail id	String(75)	-	abc@xyz.com

Success Response

{
  "body": {
    "AccountType": "S",
    "ActivationDate": "20190101",
    "BankAccountNumber": "00050XXXXXXX",
    "BankIFSC": "XYZ0000062",
    "BankName": "XYZ BANK LTD",
    "ClientCode": "S0002",
    "ClientName": "Dummy Name",
    "CorrespondenceAddress": "ABC Apartment",
    "DOB": "19800101",
    "Email": "abc@xyz.com",
    "Mobile": "9998887770",
    "NomineeName": "",
    "PINCode": "S0002",
    "Pan": "AXXXX0000X",
    "PermanentAddress": "ABC Apartment",
    "State": "RAJASTHAN",
    "Status": "0",
    "message": "Success"
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffClientProfile",
    "status": "0",
    "statusDescription": "Success"
  }
}

Failure Response

{
  "body": {
    "Message": "Invalid Input Parameters.",
    "Status": 2,
    "_details": []
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffClientProfile",
    "status": "0",
    "statusDescription": "Success"
  }
}

Failure Response

{
  "body": {
    "Message": "No record found.",
    "Status": 1,
    "_details": []
  },
  "head": {
    "responseCode": "IIFLMarRPBackoffClientProfile",
    "status": "0",
    "statusDescription": "Success"
  }
}