Object

Shown below is a sample account.savings object.

{
  "id": "sa_sbmF2TK47qn40WWk4r529YrZs53W",
  "object": "account.savings",
  "type": "savings",
  "bank_name": "sbm_bank",
  "title": "dr",
  "name": "Anil Reddy",
  "mobile_number": "9000004231",
  "email": "[email protected]",
  "account_number": "13951056287",
  "ifsc_code": "STCB0000065",
  "bank_customer_id": "R002497414",
  "kyc": {
    "pan_verification_id": "pan_z6NCQXq8OyZvBe112TV1yvb7p",
    "aadhaar_verification_id": "adh_haKDPEresRq1ojM67uyC8bT46",
    "ckyc_verification_id": "ckyc_imRNbZ8l93poSemqF2N8wm3N3",
    "photo_match_id": "phm_aCn9JHQfYUqzsc97PAdRDljVU",
    "name_match_id": "nm_5JU8e3oej2I2O3N5LnEQurzLO",
    "mother_maiden_name": "Ganga Reddy",
    "father_name": null,
    "income": 12345.134,
    "marital_status": "single",
    "occupation": "manufacturing",
    "employment_status": "retired",
    "gender": "male",
    "date_of_birth": "1997-06-28",
    "source_of_income": "inheritance"
  },
  "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": "9000004231"
      }
    }
  ],
  "addresses": [
    {
      "type": "communication",
      "address": "221B Baker Street",
      "landmark": "Opposite Wollaton Hall",
      "city": "Bangalore",
      "state_code": "KA",
      "postal_code": "560005"
    },
    {
      "type": "home",
      "address": "Father's name as per Aadhaar records, THUKALIL HOUSE, Marampally, MANJAPETTY, Marampilly, Kunnathunad, Ernakulam",
      "landmark": null,
      "city": "Ernakulam",
      "state_code": "KL",
      "postal_code": "683105"
    }
  ],
  "documents": [
    {
      "type": "customer_photo",
      "id": "doc_5SCYI02AfZSkIv4BuMmkkenNm"
    },
    {
      "type": "customer_signature",
      "id": "doc_U25KMb2aXFeow03BXwv1B2zkv"
    }
  ],
  "device_data": {
    "latitude": 35.1903,
    "longitude": 19.6806,
    "ip_address": "58d1:9073:8fe9:5982:3b31:fb16:13ae:8d58"
  },
  "customer": {
    "id": "cus_kSNSpBkvt4Thu4SQNZBsHoHgm",
    "mobile_number": "9000004231"
  },
  "is_full_kyc_completed": true,
  "kyc_method": "ckyc",
  "redirection_url": null,
  "metadata": {},
  "status": "active",
  "message": "Active",
  "is_frozen": true,
  "reason_for_freeze": null,
  "is_first_funded": false,
  "created_at": 1677576397,
  "is_sandbox": true
}

The table below lists the various parameters in the account.savings object.

Parameters	Type	Description
id	`string`	Unique identifier of the savings account in the ZWITCH database. Has to be 28 characters. Example: `sa_RxZV6CisIyllRor2G7Fg5TLBA` Supported characters: `A-Z` `a-z` `0-9` `_`
object	`string`	API object that is returned. Possible value: `account.savings`
type	`string`	Type of account created. Possible value: `savings`
bank_name	`string`	Bank where the savings 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`	Applicant's name. Maximum 70 characters. Example: `Anil Reddy` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `_` `,` `(` `)` `'`
mobile_number	`string`	Applicant's mobile number. Has to be 10 digits. Example: `9876543210` Supported characters: `0-9`
email	`string`	Applicant's email address. Example: `[email protected]`
account_number	`string`	Savings account number. Maximum 30 characters. Example: `18539873916` Supported characters: `A-Z` `a-z` `0-9`
ifsc_code	`string`	Savings account IFSC. Has to be 11 characters. Example: `STCB0000065` Supported characters: `A-Z` `0-9`
bank_customer_id	`string`	Unique identifier of the applicant in the bank database. Example: `R002495090`
kyc	`object`	An object that contains the applicant's KYC details. Learn more about the kyc child object.
nominee	`array of objects`	An array of objects that contain nominee details. Learn more about the nominee child object.
addresses	`array of objects`	An array of objects that contain the account holder's communication and home addresses. Learn more about the addresses child object.
documents	`array of objects`	An array of objects that contain the documents required to open a savings account. Learn more about the documents child object.
device_data	`object`	An object that contains the device details from which the create savings account request was triggered. Learn more about the device_data child object.
customer	`object`	An object that contains the applicant's details. Learn more about the customer child object.
is_full_kyc_completed	`boolean`	Possible values: `true`: KYC has been successfully verified. `false`: KYC verification is pending.
kyc_method	`string`	The method used to verify KYC details of the account holder. Possible values: `ckyc`: Applicant's KYC details were found in the CKYC database. `digital_kyc`: Applicant is not registered in the CKYC database. In-person KYC needs to be scheduled for the applicant.
redirection_url	`string`	Always null for a savings account.
metadata	`object`	An object of a key-value pair that can be used to store additional information about the entity. Note: Maximum 5 key-value pairs. Maximum 256 characters in the `metadata` object. You cannot pass a URL. You cannot use `\`. Example: `"key_1": "DD"`
status	`string`	Possible values: `account_activation_pending`: We are working with our partner bank to open the savings account. `full_kyc_pending`: Applicant's KYC details need to be verified in person. Schedule in-person KYC for the applicant. `full_kyc_initiated`: In-person KYC has been scheduled for the applicant. `bank_verification_pending`: Our partner bank is verifying the applicant's documents. `active`: Savings account is fully operational.
message	`string`	Message explaining the status of the API. Example: `Active`
is_frozen	`boolean`	Possible values: `true`: Account is frozen. You cannot debit money from the account. `false`: Money can be debited from the account.
reason_for_freeze	`string`	The reason the account was frozen. Possible values: `first_funding_not_completed`: First funding has not been completed. `suspicious_or_illegal_activity`: Suspicious or illegal activities were detected.
is_first_funded	`boolean`	Possible values: `true`: First funding is complete for the account. `false`: First funding is not yet complete for the account.
created_at	`integer`	Unix timestamp when the create savings account request was received by ZWITCH. Example: `1640179951`
is_sandbox	`boolean`	Possible values: `true`: API was triggered in sandbox mode. `false`: API was triggered in live mode.

[Child Object] KYC Object

The table below lists the various parameters in the kyc child object. This object is part of the account.savings object.

Parameters	Type	Description
pan_verification_id	`string`	Unique identifier obtained when you digitally verify the applicant's PAN. Use the PAN Verification API to digitally verify the applicant's PAN. Has to be 29 characters. Example: `pan_SYkpuiAbXC9ZHUmf2YuYFvGW1` Supported characters: `A-Z` `a-z` `0-9` `_`
aadhaar_verification_id	`string`	Unique identifier obtained when the applicant's Aadhaar is digitally verified. Use the Aadhaar Verification APIs to digitally verify the applicant's Aadhaar. Has to be 29 characters. Example: `adh_ANvftD0DR3mftb8O0qeyo8Z4D` Supported characters: `A-Z` `a-z` `0-9` `_`
ckyc_verification_id	`string`	Unique identifier of the check CKYC request in the ZWITCH database. Use the CKYC Registration API to digitally check the applicant's CKYC registration. Has to be 30 characters. Example: `ckyc_y60V1ZWa4oVpShsisqTf03asd` Supported characters: `A-Z` `a-z` `0-9` `_`
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: `A-Z` `a-z` `0-9` `_`
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: `A-Z` `a-z` `0-9` `_`
mother_maiden_name	`string`	Applicant's mother's maiden name. Maximum 70 characters. Example: `Ganga Reddy` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `_` `,` `(` `)` `'`
father_name	`string`	Applicant's father's name as per the applicant's Aadhaar records. Maximum 70 characters. Example: `Sunil Reddy` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `_` `,` `(` `)` `'`
income	`float`	Applicant's annual income. Minimum value: `0.00` Maximum value: `9999999999.00` (999 cr) Example: `12345.67`
marital_status	`string`	Applicant's marital status. Use the Marital Status API to get a list of accepted values.
occupation	`string`	Applicant's occupation. Use the Occupations API to get a list of accepted values. Example: `salaried`
employment_status	`string`	Applicant's employment status. Use the Employment Status API to get a list of accepted values. Example: `retired`
gender	`string`	Applicant's gender as per their Aadhaar records. Possible values: `male` `female` `other`
date_of_birth	`string`	Applicant'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: `0-9` `-`
source_of_income	`string`	Applicant's source of income. Use the Source of Income API to get a list of accepted values. Example: `salary`

[Child Object] Nominee Object

The table below lists the various parameters in the nominee child object. This object is part of the account.savings object.

Parameter	Type	Description
name	`string`	Nominee's name. Maximum 70 characters. Example: `Ram Reddy` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `_` `,` `(` `)` `'`
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: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `,` `#`
state_code	`string`	Nominee's state code according to their KYC document. Use the State Codes API to get a list of accepted values. Example: `KA`
city	`string`	Nominee's city according to their KYC document. Example: `Bangalore` Supported characters: `A-Z` `a-z` `0-9` `space` `_` `()` `.`
postal_code	`string`	Nominee's pincode according to their KYC document. Has to be 6 digits. Example: `560005` Supported characters: `0-9`
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: `0-9` `-`
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 child 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: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `_` `,` `(` `)` `'`
relation	`string`	Guardian's relation to the nominee. Possible values: `father` `mother` `others` Example: `mother`
address	`string`	Guardian's address according to their KYC document. Maximum 135 characters. Example: `221B Baker Street` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `,` `#`
state_code	`string`	Guardian's state code according to their KYC document. Use the State Codes API to get a list of accepted values. Example: `KA`
city	`string`	Guardian's city according to their KYC document. Example: `Bangalore` Supported characters: `A-Z` `a-z` `0-9` `space` `_` `()` `.`
postal_code	`string`	Guardian's pincode according to their KYC document. Has to be 6 digits. Example: `560005` Supported characters: `0-9`
mobile_number	`string`	Guardian's mobile number. Has to be 10 digits. Example: `9876543210` Supported characters: `0-9`

[Child Object] Address Object

The table below lists the various parameters in the addresses child object. This object is part of the account.savings object.

Parameters	Type	Description
type	`string`	Applicant's address type. Possible values: `communication`: Applicant's communication address. All postal correspondence from the bank will be sent to this address. `home`: Applicant's permanent address according to their KYC document.
address	`string`	Applicant's address. Maximum 135 characters. Example: `221B, Baker Street` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `,` `#`
landmark	`string`	Landmark for the address. Maximum 135 characters. Example: `Opposite Wollaton House` Supported characters: `A-Z` `a-z` `0-9` `.` `/` `\` `-` `,` `#`
city	`string`	Applicant's city. Example: `Bangalore` Supported characters: `A-Z` `a-z` `0-9` `space` `_` `()` `.`
state_code	`string`	Applicant's state code. Use the State Codes API to get a list of accepted values. Example: `KA`
postal_code	`string`	Applicant's pincode. Has to be 6 digits. Example: `560005` Supported characters: `0-9`

[Child Object] Documents Object

The table below lists the various parameters in the document child object. This object is part of the account.savings 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: `A-Z` `a-z` `0-9` `_`
type	`string`	Type of document uploaded. Possible values: `customer_photo`

[Child Object] Device Data Object

The table below lists the various parameters in the device_data child object. This object is part of the account.savings object.

Parameter Type Description

latitude

Parameter	Type	Description
latitude	`float`	Latitude of the device from which the create savings account is sent. Note: Has to be between `-90` and `90`. Minimum: 2 decimals Maximum: 14 decimals Example: `12.9013` Supported characters: `0-9` `.`
longitude	`float`	Longitude of the device from which the create savings account is sent. Note: Has to be between `-180` and `180`. Minimum: 2 decimals Maximum: 14 decimals Example: `12.9013` Supported characters: `0-9` `.`
ip_address	`string`	IP address of the device from which the create savings account is sent. Supported IP address formats: IPv4 address IPv6 address Example: `96fe:8cf3:4550:9632:e66b:d552:0124:275a`

float

Latitude of the device from which the create savings account is sent.

Note:

Has to be between -90 and 90.
Minimum: 2 decimals
Maximum: 14 decimals

Example: 12.9013

Supported characters:

0-9
.

longitude

float

Longitude of the device from which the create savings account is sent.

Note:

Has to be between -180 and 180.
Minimum: 2 decimals
Maximum: 14 decimals

Example: 12.9013

Supported characters:

0-9
.

ip_address

string

IP address of the device from which the create savings account is sent.

Supported IP address formats:

IPv4 address
IPv6 address

Example: 96fe:8cf3:4550:9632:e66b:d552:0124:275a

[Child Object] Customer Object

The table below lists the various parameters in the customer child object. This object is part of the account.savings 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: `A-Z` `a-z` `0-9` `_`
mobile_number	`string`	Applicant's mobile number. Has to be 10 digits. Example: `9876543210` Supported characters: `0-9`