Overview of the account.current
object.
Shown below is a sample account.current
object.
{
"id": "ca_jLGcJ568Xp00gv7ukl361kYoQ",
"object": "account.current",
"type": "current",
"bank_name": "sbm_bank",
"title": "mr",
"name": "Anil Reddy",
"mobile_number": "9000001284",
"email": "[email protected]",
"account_number": "153104951231",
"ifsc_code": "STCB0000065",
"bank_customer_id": "C000007369",
"kyc": {
"pan_verification_id": "pan_SYkpuiAbXC9ZHUmf2YuYFvGW1",
"aadhaar_verification_id": "adh_ANvftD0DR3mftb8O0qeyo8Z4D",
"ckyc_verification_id": "ckyc_y60V1ZWa4oVpShsisqTf03asd",
"photo_match_id": "phm_r3uI21d6kzAWtPQB6C1ctyPPy",
"name_match_id": "nm_joLCtvh0X9gNXwE",
"gender": "male",
"date_of_birth": "1997-06-28",
"mother_maiden_name": "Ganga Reddy",
"father_name": "Sunil Reddy",
"marital_status": "single",
"income": 1000.62,
"occupation": "self_employed_business",
"business_type": "proprietorship",
"business_category": "manufacturing",
"contact_person": "Anil Reddy",
"date_of_incorporation": "2021-12-31",
"website": "https://www.example.com",
"source_of_income": "others"
},
"nominee": [
{
"name": "Ram Reddy",
"relation": "son",
"address": "221B Baker Street",
"state_code": "KA",
"city": "Bangalore",
"postal_code": "560005",
"date_of_birth": "2020-12-31",
"guardian": {
"name": "Gita Reddy",
"relation": "mother",
"address": "221B Baker Street",
"state_code": "KA",
"city": "Bangalore",
"postal_code": "560005",
"mobile_number": "9000001284"
}
}
],
"addresses": [
{
"type": "communication",
"address": "221B Baker Street",
"landmark": "Opposite Wollaton Hall",
"city": "Bangalore",
"state_code": "KA",
"postal_code": "560001"
},
{
"type": "work",
"address": "221B Baker Street",
"landmark": "Opposite Wollaton Hall",
"city": "Bangalore",
"state_code": "KA",
"postal_code": "560001"
},
{
"type": "home",
"address": "221B Baker Street",
"landmark": "Opposite Wollaton Hall",
"city": "Bangalore",
"state_code": "KA",
"postal_code": "560005"
}
],
"documents": [
{
"type": "customer_photo",
"id": "doc_bXMFERcNf8lKj6lovf0Fy4jiO",
"reference_number": null,
"date_of_issue": null
},
{
"type": "customer_signature",
"id": "doc_LLr4vFC2LNvNiLfPUma9tMttJ",
"reference_number": null,
"date_of_issue": null
},
{
"type": "registration_certificate",
"id": "doc_QIGzC9XLmBEUrEMasMONoP6A8",
"reference_number": "123412341234",
"date_of_issue": "2021-12-31"
},
{
"type": "shop_and_establishment_license",
"id": "doc_Oeh2IBylqr5ElDHf3pN8JcbsB",
"reference_number": "123412341234",
"date_of_issue": "2021-12-31"
}
],
"device_data": {
"latitude": 11.3265,
"longitude": 51.7118,
"ip_address": "22de:f174:1269:ea97:b0ee:44ff:c8f8:5689"
},
"customer": {
"id": "cus_asraiJjdezc0aHMkl1BlZf4E6",
"mobile_number": "9000001284"
},
"kyc_method": "digital_kyc",
"redirection_url": null,
"metadata": {
"key_1": "DD",
"key_2": "XOF"
},
"failed_reason": {},
"status": "full_kyc_pending",
"is_frozen": false,
"is_first_funded": false,
"created_at": 1657525366,
"is_sandbox": true
}
The table below lists the various parameters in the current account object.
Parameters | Type | Description |
---|---|---|
id | string | Unique identifier of the current account in the ZWITCH database. Has to be 28 characters. Example: ca_RxZV6CisIyllRor2G7Fg5TLBA Supported characters:
|
object | string | API object that is returned. Possible value: account.current |
type | string | Type of account created. Possible value: current |
bank_name | string | Bank where the current account is created. Possible value: sbm_bank |
title | string | Applicant's title. Use the Titles API to get a list of accepted values. Example: dr |
name | string | Name of the applicant or the registered business. Maximum 70 characters. Example: Anil Reddy Enterprises Supported characters:
|
mobile_number | string | Mobile number of the applicant or the registered business. Has to be 10 digits. Example: 9876543210 Supported characters:
|
string | Email address of the applicant or the registered business. Example: [email protected] | |
account_number | string | Current account number. Maximum 30 characters. Example: 18539873916 Supported characters:
|
ifsc_code | string | Current account IFSC. Has to be 11 characters. Example: STCB0000065 Supported characters:
|
bank_customer_id | string | Unique identifier of the applicant or registered business in the bank database. Example: C000002814 |
kyc | object | Object that contains the KYC details of the applicant or registered business. Learn more about the kyc child object. |
nominee | array of objects | Array of objects that contains nominee details. Learn more about the nominee child object. |
addresses | array of objects | Array of objects that contain the communication and home address of the applicant or registered business. Learn more about the addresses child object. |
documents | array of objects | Array of objects that contains the documents required to open a current account. Learn more about the documents child object. |
device_data | object | Object that contains the device details from which the create current account request was triggered. Learn more about the device_data child object. |
customer | object | Object that contains details about the applicant or registered business. Learn more about the customer child object. |
kyc_method | string | Method used to verify KYC details of the applicant or registered business. Possible values:
|
redirection_url | string | Always null for current account. |
metadata | object | Object of key-value pair that can be used to store additional information about the entity. Note:
"key_1": "DD" |
failed_reason | object | Object that returns a list of reason why the account opening request was rejected by the bank. Possible values:
|
status | string | Possible values:
|
is_frozen | boolean | Possible values:
|
is_first_funded | boolean | Possible values:
|
ckyc_verification_id | string | Unique identifier of the check CKYC request in the ZWITCH database. Has to be 30 characters. Example: ckyc_y60V1ZWa4oVpShsisqTf03asd Supported characters:
|
created_at | integer | Unix timestamp when the create current account request was received by ZWITCH. Example: 1640179951 |
is_sandbox | boolean | Possible values:
|
[Child Object] KYC Object
The table below lists the various parameters in the kyc
object. This object is part of the account.current
object.
Parameters | Type | Description |
---|---|---|
pan_verification_id | string | Unique identifier obtained when the applicant's or business owner's PAN is digitally verified. Use the Verify PAN API to digitally verify the applicant's or business owner's PAN. Has to be 29 characters. Example: pan_SYkpuiAbXC9ZHUmf2YuYFvGW1 Supported characters:
|
aadhaar_verification_id | string | Unique identifier obtained when the applicant's or business owner's Aadhaar is digitally verified. Use the Verify Aadhaar APIs to digitally verify the applicant's or business owner's Aadhaar. Has to be 29 characters. Example: adh_ANvftD0DR3mftb8O0qeyo8Z4D Supported characters:
|
ckyc_verification_id | string | Unique identifier of the check CKYC registration request in the ZWITCH database. Use the Check CKYC Registration API to digitally check the applicant's CKYC registration. Has to be 30 characters. Example: ckyc_y60V1ZWa4oVpShsisqTf03asd Supported characters:
|
photo_match_id | string | Unique identifier of the photo match request in the ZWITCH database. Use the Photo Verification API to digitally verify the applicant's photo. Has to be 29 characters. Example: phm_r3uI21d6kzAWtPQB6C1ctyPPy Supported characters:
|
name_match_id | string | Unique identifier of the name match request in the ZWITCH database. Use the Name Verification API to digitally verify the applicant's name. Has to be 18 characters. Example: nm_joLCtvh0X9gNXwE Supported characters:
|
gender | string | Applicant's or business owner's gender as per their Aadhaar records. Possible values:
|
date_of_birth | string | Applicant's or business owner's date of birth according to their Aadhaar records. Possible format: YYYY-MM-DD Has to be 10 characters. Example: 1987-12-31 Supported characters:
|
mother_maiden_name | string | Applicant's or business owner's mother's maiden name. Maximum 70 characters. Example: Ganga Reddy Supported characters:
|
father_name | string | Applicant's or business owner's father's name as per the applicant's or business owner's Aadhaar records. Maximum 70 characters. Example: Sunil Reddy Supported characters:
|
marital_status | string | Applicant's or business owner's marital status. Possible values:
|
income | float | Applicant's or business owner's annual income or annual turnover of the registered business.
12345.67 |
occupation | string | Applicant's or business owner's occupation. Use the Occupations API to get a list of accepted values. Example: salaried |
business_type | string | Business type for the current account. Accepted values:
|
business_category | string | Business category for the current account. Use the Business Categories API to get a list of accepted values. Example: garage_owners |
contact_person | string | Contact person's name for the business. Example: Anil Reddy |
date_of_incorporation | string | Date the business was registered. Accepted format: YYYY-MM-DD Example: 2021-12-31 |
website | string | Registered business's website. Example: https://www.example.com |
source_of_income | string | Applicant's source of income. Allowed constant types:
|
[Child Object] Nominee Object
The table below lists the various parameters in the nominee
object. This object is part of the account.current
object.
Parameter | Type | Description |
---|---|---|
name | string | Nominee's name. Maximum 70 characters. Example: Ram Reddy Supported characters:
|
relation | string | Nominee's relation to the Account holder. Use the Relations API to get a list of accepted values. Example: son |
address | string | Nominee's permanent address. Maximum 135 characters. Example: 221B Baker Street Supported characters:
|
state_code | string | Nominee's state code according to their KYC document. Use the States API to get a list of accepted values. Example: KA |
city | string | Nominee's city according to their KYC document. Example: bangalore Supported characters:
|
postal_code | string | Nominee's pincode according to their KYC document. Has to be 6 digits. Example: 560005 Supported characters:
|
date_of_birth | string | Nominee's date of birth according to their KYC document. Accepted format: YYYY-MM-DD Has to be 10 characters. Example: 1987-12-31 Supported characters:
|
guardian | object | Mandatory if the nominee is under the age of 18 . Object that contains the nominee's guardian details. Learn more about the guardian child object. |
[Child Object] Guardian Object
The table below lists the various parameters in the guardian
object. This object is part of the nominee
child object.
Parameter | Type | Description |
---|---|---|
name | string | Guardian's name. Maximum 70 characters. Example: Gita Reddy Supported characters:
|
relation | string | Guardian's relation to the nominee. Possible values:
Example: mother |
address | string | Guardian's address according to their KYC document. Maximum 135 characters. Example: 221B Baker Street Supported characters:
|
state_code | string | Guardian's state code according to their KYC document. Use the States API to get a list of accepted values. Example: KA |
city | string | Guardian's city according to their KYC document. Example: Bangalore Supported characters:
|
postal_code | string | Guardian's pincode according to their KYC document. Has to be 6 digits. Example: 560005 Supported characters:
|
mobile_number | string | Guardian's mobile number. Has to be 10 digits. Example: 9876543210 Supported characters:
|
[Child Object] Address Object
The table below lists the various parameters in the addresses
object. This object is part of the account.current
object.
Parameters | Type | Description |
---|---|---|
type | string | Applicant's or registered business's address type. Possible values:
|
address | string | Address of the applicant or registered business. Maximum 135 characters. Example: 221B, Baker Street Supported characters:
|
landmark | string | Landmark for the address. Maximum 135 characters. Example: Opposite Wollaton House Supported characters:
|
city | string | City of the applicant or registered business. Example: Bangalore Supported characters:
|
state_code | string | State code of the applicant or registered business. Use the State Codes API to get a list of accepted values. Example: KA |
postal_code | string | Pincode of the applicant or registered business. Has to be 6 digits. Example: 560005 Supported characters:
|
[Child Object] Documents Object
The table below lists the various parameters in the document
object. This object is part of the account.current
object.
Parameter | Type | Description |
---|---|---|
id | string | The unique identifier for the document uploaded. Use the Upload Document API to upload the required document and get the document id. Has to be 29 characters. Example: doc_Siu6Q30cFBU6unBS3TF7s7NzN .Supported characters:
|
type | string | The type of file you uploaded. Possible values:
|
reference_number | string | Identification number of the document. Example: 123456789012345 |
date_of_issue | string | Date the document was issued. Accepted format: YYYY-MM-DD Has to be 10 characters. Example: 2021-12-31 Supported characters:
|
[Child Object] Device Data Object
The table below lists the various parameters in the device_data
object. This object is part of the account.current
object.
Parameter | Type | Description |
---|---|---|
latitude | float | Latitude of the device from which the create current account is sent. Note:
12.9013 Supported characters:
|
longitude | float | Longitude of the device from which the create current account is sent. Note:
12.9013 Supported characters:
|
ip_address | string | IP address of the device from which the create current account is sent. Supported IP address formats:
96fe:8cf3:4550:9632:e66b:d552:0124:275a |
[Child Object] Customer Object
The table below lists the various parameters in the customer
object. This object is part of the account.current
object.
Parameter | Type | Description |
---|---|---|
id | string | Unique identifier of the applicant in the ZWITCH database. Has to be 29 characters. Example: cus_lmPl9XliJ09yisvcWKrff2WCR .Supported characters:
|
mobile_number | string | Mobile number of the applicant or registered business. Has to be 10 digits. Example: 9876543210 Supported characters:
|