Fixed Deposit Booking

List of Applications

Introduction:
﻿
Sample cURL:
preproduction
production
curl --location 'https://api.signzy.app/api/v3/fd-booking/get-all-applications' \
--header 'Authorization: <auth token>' \
--header 'Content-Type: application/json' \
--data '{
    "offset": 0,
    "limit": 10,
    "status": "active",
    "excludeStatus": "awaiting_payment"
}'
curl --location 'https://api.signzy.app/api/v3/fd-booking/get-all-applications' \
--header 'Authorization: <auth token>' \
--header 'Content-Type: application/json' \
--data '{
    "offset": 0,
    "limit": 10,
    "status": "active",
    "excludeStatus": "awaiting_payment"
}'
﻿
Input Parameters:
Parameter
Type
Description
Mandatory/Optional
offset
Number
Number of records to skip.                   Default: 0
Optional
limit
Number
Maximum number of records to return. Default: 10                                                Value: [1, 100]
Optional
status
String
Status of the application.                     Value: ["new""awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"]
Optional
excludeStatus
String
Status that have to be excluded.                     Value: ["new", "awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"]
Optional
Output Parameters: 
Key
Type
Description
total
Number
Total number of records matching the specified criteria.
limit
Number
Maximum number of records returned.
offset
Number
Number of records skipped.
applications
Array of Objects
List of all applications.
applications.id
String
Unique identifier of application.
applications.maturityAmount
Number
Amount at maturity.
applications.maturityDate
String
Maturity date.
applications.fdrReference
String
Reference number for the fixed deposit receipt.
applications.fdrDate
String
Date of the fixed deposit receipt.
applications.status
String
Status of the application.                                     Value: ["new""awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"]
applications.schemeId
String
Identifier for the associated scheme.
applications.tenure
Number
Tenure of the application.
applications.amount
Number
Amount applied.
applications.payableTo
String
Payable to.                                                           Value: ["first_holder"]
applications.applicants
Array of Objects
Applicant information.
applications.applicants.salutation
String
Salutation of the applicant.                                 Value: ["mr", "mrs", "ms"]
applications.applicants.firstName
String
First name of the applicant.
applications.applicants.middleName
String
Middle name of the applicant.
applications.applicants.lastName
String
Last name of the applicant.
applications.applicants.dateOfBirth
String
Date of birth of the applicant (ISO 8601 date format). For example, "2017-07-21"
applications.applicants.gender
String
Gender of the applicant.                                                  Value: ["male", "female", "transgender"]
applications.applicants.email
String
Email address of the applicant.
applications.applicants.mobile
String
Mobile number of the applicant.
applications.applicants.pan
String
PAN number of the applicant (10 characters).
applications.applicants.aadhaar
String
Aadhaar number of the applicant (12 characters).
applications.applicants.ckycNumber
String
ckyc number of the applicant.
applications.applicants.maritalStatus
String
Marital status of the applicant.                                          Value: ["married", "unmarried", "other"]
applications.applicants.annualIncome
String
Annual income range of the applicant.                              Value: ["upto_5_lakh", "above_5_lakh_upto_10_lakh", "above_10_lakh_upto_15_lakh", "above_15_lakh_upto_25_lakh", "above_25_lakh_upto_50_lakh", "above_50_lakh_upto_1_crore", "above_1_crore"]
applications.applicants.occupation
String
Occupation of the applicant.                               Value: ["business", "agriculture", "forex_dealer", "service_public_sector", "service_private_sector", "service_government_sector", "others_professional", "others_self_employed", "others_retired", "others_housewife", "others_student", "others"]
applications.applicants.birthPlace
String
Place of birth of the applicant.
applications.applicants.birthCountry
String
Country of birth of the applicant.
applications.applicants.nationality
String
Nationality of the applicant.                                Value: ["indian"]
applications.applicants.spouse
Object
Details of the spouse, if applicable.
applications.applicants.spouse.salutation
String
Salutation of the spouse.                                     Value: ["mr", "mrs", "ms"]
applications.applicants.spouse.firstName
String
First name of the spouse.
applications.applicants.spouse.middleName
String
Middle name of the spouse.
applications.applicants.spouse.lastName
String
Last name of the spouse.
applications.applicants.father
Object
Details of the father, if applicable.
applications.applicants.father.salutation
String
Salutation of the father.                                       Value: ["mr", "mrs", "ms"]
applications.applicants.father.firstName
String
First name of the father.
applications.applicants.father.middleName
String
Middle name of the father.
applications.applicants.father.lastName
String
Last name of the father.
applications.applicants.residentialAddress
Object
Residential address of the applicant.
applications.applicants.residentialAddress.addressLine1
String
Address line 1.
applications.applicants.residentialAddress.addressLine2
String
Address line 2.
applications.applicants.residentialAddress.addressLine3
String
Address line 3.
applications.applicants.residentialAddress.city
String
City 
applications.applicants.residentialAddress.state
String
State
applications.applicants.residentialAddress.pincode
String
Pincode 
applications.applicants.residentialAddress.country
String
Country
applications.applicants.permanentAddressSameAsResidential
Boolean
Indicates if the permanent address is the same as residential address.
schemes.applicants.permanentAddress
Object
Permanent address of the applicant, if different from residential address.
applications.applicants.permanentAddress.addressLine1
String
Address line 1.
applications.applicants.permanentAddress.addressLine2
String
Address line 2.
applications.applicants.permanentAddress.addressLine3
String
Address line 3.
applications.applicants.permanentAddress.city
String
City
applications.applicants.permanentAddress.state
String
State
applications.applicants.permanentAddress.pincode
String
Pincode
applications.applicants.permanentAddress.country
String
Country
applications.bank
Object
Bank details of applicant.
applications.bank.accountType
String
Type of bank account.                                         Value: ["savings", "current"]
applications.bank.ifsc
String
IFSC code of the bank branch.
applications.bank.accountNumber
String
Account number.
applications.nominees
Array of Objects
Detail of nominees.
applications.nominees.salutation
String
Salutation of the nominee.                                       Value: ["mr", "mrs", "ms"]
applications.nominees.firstName
String
First name of the nominee.
applications.nominees.middleName
String
Middle name of the nominee.
applications.nominees.lastName
String
Last name of the nominee.
applications.nominees.dateOfBirth
String
Date of birth of the nominee (ISO 8601 date format).  For example, "2017-07-21"
applications.nominees.relation
String
Relation to the applicant.                                       Value: ["brother", "sister", "father", "mother", "son", "daughter", "husband", "wife", "other"]
applications.nominees.guardian
Object
Guardian details of nominee. Its required if nominee is minor.
applications.nominees.guardian.salutation
String
Salutation of the guardian.                                       Value: ["mr", "mrs", "ms"]
applications.nominees.guardian.firstName
String
First name of the guardian.
applications.nominees.guardian.middleName
String
Middle name of the guardian.
applications.nominees.guardian.lastName
String
Last name of the guardian.
applications.ipAddress
String
IP address of the user.
Status Codes:
200
400
401
404
409
500
{
    "message": "Invalid authentication credentials"
}
{
    "message": "Invalid authentication credentials"
}
﻿
﻿

Application Details

Upload Documents

Docs powered by Archbee

TABLE OF CONTENTS

Parameter	Type	Description	Mandatory/Optional
offset	Number	Number of records to skip. Default: 0	Optional
limit	Number	Maximum number of records to return. Default: 10 Value: [1, 100]	Optional
status	String	Status of the application. Value: ["new""awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"]	Optional
excludeStatus	String	Status that have to be excluded. Value: ["new", "awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"]	Optional

Key	Type	Description
total	Number	Total number of records matching the specified criteria.
limit	Number	Maximum number of records returned.
offset	Number	Number of records skipped.
applications	Array of Objects	List of all applications.
applications.id	String	Unique identifier of application.
applications.maturityAmount	Number	Amount at maturity.
applications.maturityDate	String	Maturity date.
applications.fdrReference	String	Reference number for the fixed deposit receipt.
applications.fdrDate	String	Date of the fixed deposit receipt.
applications.status	String	Status of the application. Value: ["new""awaiting_payment", "awaiting_documents", "under_review", "active", "matured", "rejected"]
applications.schemeId	String	Identifier for the associated scheme.
applications.tenure	Number	Tenure of the application.
applications.amount	Number	Amount applied.
applications.payableTo	String	Payable to. Value: ["first_holder"]
applications.applicants	Array of Objects	Applicant information.
applications.applicants.salutation	String	Salutation of the applicant. Value: ["mr", "mrs", "ms"]
applications.applicants.firstName	String	First name of the applicant.
applications.applicants.middleName	String	Middle name of the applicant.
applications.applicants.lastName	String	Last name of the applicant.
applications.applicants.dateOfBirth	String	Date of birth of the applicant (ISO 8601 date format). For example, "2017-07-21"
applications.applicants.gender	String	Gender of the applicant. Value: ["male", "female", "transgender"]
applications.applicants.email	String	Email address of the applicant.
applications.applicants.mobile	String	Mobile number of the applicant.
applications.applicants.pan	String	PAN number of the applicant (10 characters).
applications.applicants.aadhaar	String	Aadhaar number of the applicant (12 characters).
applications.applicants.ckycNumber	String	ckyc number of the applicant.
applications.applicants.maritalStatus	String	Marital status of the applicant. Value: ["married", "unmarried", "other"]
applications.applicants.annualIncome	String	Annual income range of the applicant. Value: ["upto_5_lakh", "above_5_lakh_upto_10_lakh", "above_10_lakh_upto_15_lakh", "above_15_lakh_upto_25_lakh", "above_25_lakh_upto_50_lakh", "above_50_lakh_upto_1_crore", "above_1_crore"]
applications.applicants.occupation	String	Occupation of the applicant. Value: ["business", "agriculture", "forex_dealer", "service_public_sector", "service_private_sector", "service_government_sector", "others_professional", "others_self_employed", "others_retired", "others_housewife", "others_student", "others"]
applications.applicants.birthPlace	String	Place of birth of the applicant.
applications.applicants.birthCountry	String	Country of birth of the applicant.
applications.applicants.nationality	String	Nationality of the applicant. Value: ["indian"]
applications.applicants.spouse	Object	Details of the spouse, if applicable.
applications.applicants.spouse.salutation	String	Salutation of the spouse. Value: ["mr", "mrs", "ms"]
applications.applicants.spouse.firstName	String	First name of the spouse.
applications.applicants.spouse.middleName	String	Middle name of the spouse.
applications.applicants.spouse.lastName	String	Last name of the spouse.
applications.applicants.father	Object	Details of the father, if applicable.
applications.applicants.father.salutation	String	Salutation of the father. Value: ["mr", "mrs", "ms"]
applications.applicants.father.firstName	String	First name of the father.
applications.applicants.father.middleName	String	Middle name of the father.
applications.applicants.father.lastName	String	Last name of the father.
applications.applicants.residentialAddress	Object	Residential address of the applicant.
applications.applicants.residentialAddress.addressLine1	String	Address line 1.
applications.applicants.residentialAddress.addressLine2	String	Address line 2.
applications.applicants.residentialAddress.addressLine3	String	Address line 3.
applications.applicants.residentialAddress.city	String	City
applications.applicants.residentialAddress.state	String	State
applications.applicants.residentialAddress.pincode	String	Pincode
applications.applicants.residentialAddress.country	String	Country
applications.applicants.permanentAddressSameAsResidential	Boolean	Indicates if the permanent address is the same as residential address.
schemes.applicants.permanentAddress	Object	Permanent address of the applicant, if different from residential address.
applications.applicants.permanentAddress.addressLine1	String	Address line 1.
applications.applicants.permanentAddress.addressLine2	String	Address line 2.
applications.applicants.permanentAddress.addressLine3	String	Address line 3.
applications.applicants.permanentAddress.city	String	City
applications.applicants.permanentAddress.state	String	State
applications.applicants.permanentAddress.pincode	String	Pincode
applications.applicants.permanentAddress.country	String	Country
applications.bank	Object	Bank details of applicant.
applications.bank.accountType	String	Type of bank account. Value: ["savings", "current"]
applications.bank.ifsc	String	IFSC code of the bank branch.
applications.bank.accountNumber	String	Account number.
applications.nominees	Array of Objects	Detail of nominees.
applications.nominees.salutation	String	Salutation of the nominee. Value: ["mr", "mrs", "ms"]
applications.nominees.firstName	String	First name of the nominee.
applications.nominees.middleName	String	Middle name of the nominee.
applications.nominees.lastName	String	Last name of the nominee.
applications.nominees.dateOfBirth	String	Date of birth of the nominee (ISO 8601 date format). For example, "2017-07-21"
applications.nominees.relation	String	Relation to the applicant. Value: ["brother", "sister", "father", "mother", "son", "daughter", "husband", "wife", "other"]
applications.nominees.guardian	Object	Guardian details of nominee. Its required if nominee is minor.
applications.nominees.guardian.salutation	String	Salutation of the guardian. Value: ["mr", "mrs", "ms"]
applications.nominees.guardian.firstName	String	First name of the guardian.
applications.nominees.guardian.middleName	String	Middle name of the guardian.
applications.nominees.guardian.lastName	String	Last name of the guardian.
applications.ipAddress	String	IP address of the user.