Object

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.

ParametersTypeDescription
idstringUnique identifier of the current account in the ZWITCH database.

Has to be 28 characters.

Example: ca_RxZV6CisIyllRor2G7Fg5TLBA

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • _
objectstringAPI object that is returned.

Possible value: account.current
typestringType of account created.

Possible value: current
bank_namestringBank where the current account is created.

Possible value: sbm_bank
titlestringApplicant's title.

Use the Titles API to get a list of accepted values.

Example: dr
namestringName of the applicant or the registered business.

Maximum 70 characters.

Example: Anil Reddy Enterprises

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • .
  • /
  • \
  • -
  • _
  • ,
  • (
  • )
  • '
mobile_numberstringMobile number of the applicant or the registered business.

Has to be 10 digits.

Example: 9876543210

Supported characters:
  • 0-9
emailstringEmail address of the applicant or the registered business.

Example: [email protected]
account_numberstringCurrent account number.

Maximum 30 characters.

Example: 18539873916

Supported characters:
  • A-Z
  • a-z
  • 0-9
ifsc_codestringCurrent account IFSC.

Has to be 11 characters.

Example: STCB0000065

Supported characters:
  • A-Z
  • 0-9
bank_customer_idstringUnique identifier of the applicant or registered business in the bank database.

Example: C000002814
kycobjectObject that contains the KYC details of the applicant or registered business.

Learn more about the kyc child object.
nomineearray of objectsArray of objects that contains nominee details.

Learn more about the nominee child object.
addressesarray of objectsArray of objects that contain the communication and home address of the applicant or registered business.

Learn more about the addresses child object.
documentsarray of objectsArray of objects that contains the documents required to open a current account.

Learn more about the documents child object.
device_dataobjectObject that contains the device details from which the create current account request was triggered.

Learn more about the device_data child object.
customerobjectObject that contains details about the applicant or registered business.

Learn more about the customer child object.
kyc_methodstringMethod used to verify KYC details of the applicant or registered business.

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_urlstringAlways null for current account.
    metadataobjectObject of 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"
    failed_reasonobjectObject that returns a list of reason why the account opening request was rejected by the bank.

    Possible values:
    • aadhaar_not_clear
    • name_not_matching
    statusstringPossible values:
    • account_activation_pending: We are working with our partner bank to open the current 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.
    • bank_verification_failed: Our partner bank has rejected the one or more of the applicant's documents.
    • active: Savings account is fully operational.
    is_frozenbooleanPossible values:
    • true: Account is frozen. You cannot debit money from the account.
    • false: Money can be debited from the account.
    is_first_fundedbooleanPossible values:
    • true: First funding is complete for the account.
    • false: First funding is not yet complete for the account.
    ckyc_verification_idstringUnique identifier of the check CKYC request in the ZWITCH database.

    Has to be 30 characters.

    Example: ckyc_y60V1ZWa4oVpShsisqTf03asd

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • _
    created_atinteger Unix timestamp when the create current account request was received by ZWITCH.

    Example: 1640179951
    is_sandboxbooleanPossible 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 object. This object is part of the account.current object.

    ParametersTypeDescription
    pan_verification_idstringUnique 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:
    • A-Z
    • a-z
    • 0-9
    • _
    aadhaar_verification_idstringUnique 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:
    • A-Z
    • a-z
    • 0-9
    • _
    ckyc_verification_idstringUnique 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:
    • A-Z
    • a-z
    • 0-9
    • _
    photo_match_idstringUnique 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_idstringUnique 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
    • _
    genderstringApplicant's or business owner's gender as per their Aadhaar records.

    Possible values:
    • male
    • female
    • other
    date_of_birthstringApplicant'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:
    • 0-9
    • -
    mother_maiden_namestringApplicant's or business owner's mother's maiden name.

    Maximum 70 characters.

    Example: Ganga Reddy

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • _
    • ,
    • (
    • )
    • '
    father_namestringApplicant'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:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • _
    • ,
    • (
    • )
    • '
    marital_statusstringApplicant's or business owner's marital status.

    Possible values:
    • single
    • married
    • divorced
    • widow
    • separated
    incomefloatApplicant's or business owner's annual income or annual turnover of the registered business.
    • Minimum value: 0.00
    • Maximum value: 9999999999.00 (999 cr)
    Example: 12345.67
    occupationstringApplicant's or business owner's occupation.

    Use the Occupations API to get a list of accepted values.

    Example: salaried
    business_typestringBusiness type for the current account.

    Accepted values:
    • individual
    • proprietorship
    business_categorystringBusiness category for the current account.

    Use the Business Categories API to get a list of accepted values.

    Example: garage_owners
    contact_personstringContact person's name for the business.

    Example: Anil Reddy
    date_of_incorporationstringDate the business was registered.

    Accepted format: YYYY-MM-DD

    Example: 2021-12-31
    websitestringRegistered business's website.

    Example: https://www.example.com
    source_of_incomestringApplicant's source of income.

    Allowed constant types:
    • salary
    • business
    • investment
    • inheritance
    • pension
    • rent
    • agriculture
    • others

    [Child Object] Nominee Object

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

    ParameterTypeDescription
    namestringNominee's name.

    Maximum 70 characters.

    Example: Ram Reddy

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • _
    • ,
    • (
    • )
    • '
    relationstringNominee's relation to the Account holder.

    Use the Relations API to get a list of accepted values.

    Example: son
    addressstringNominee's permanent address.

    Maximum 135 characters.

    Example: 221B Baker Street

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • ,
    • #
    state_codestringNominee's state code according to their KYC document.

    Use the States API to get a list of accepted values.

    Example: KA
    citystringNominee's city according to their KYC document.

    Example: bangalore

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • space
    • _
    • ()
    • .
    postal_codestringNominee's pincode according to their KYC document.

    Has to be 6 digits.

    Example: 560005

    Supported characters:
    • 0-9
    date_of_birthstringNominee'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
    • -
    guardianobject 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.

    ParameterTypeDescription
    namestringGuardian's name.

    Maximum 70 characters.

    Example: Gita Reddy

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • _
    • ,
    • (
    • )
    • '
    relationstringGuardian's relation to the nominee.

    Possible values:
    • father
    • mother
    • others


    Example: mother
    addressstringGuardian's address according to their KYC document.

    Maximum 135 characters.

    Example: 221B Baker Street

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • ,
    • #
    state_codestringGuardian's state code according to their KYC document.

    Use the States API to get a list of accepted values.

    Example: KA
    citystringGuardian's city according to their KYC document.

    Example: Bangalore

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • space
    • _
    • ()
    • .
    postal_codestringGuardian's pincode according to their KYC document.

    Has to be 6 digits.

    Example: 560005

    Supported characters:
    • 0-9
    mobile_numberstringGuardian'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 object. This object is part of the account.current object.

    ParametersTypeDescription
    typestringApplicant's or registered business'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.
    addressstringAddress of the applicant or registered business.

    Maximum 135 characters.

    Example: 221B, Baker Street

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • ,
    • #
    landmarkstringLandmark for the address.

    Maximum 135 characters.

    Example: Opposite Wollaton House

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • .
    • /
    • \
    • -
    • ,
    • #
    citystringCity of the applicant or registered business.

    Example: Bangalore

    Supported characters:
    • A-Z
    • a-z
    • 0-9
    • space
    • _
    • ()
    • .
    state_codestringState code of the applicant or registered business.

    Use the State Codes API to get a list of accepted values.

    Example: KA
    postal_codestringPincode of the applicant or registered business.

    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 object. This object is part of the account.current object.

    ParameterTypeDescription
    idstringThe 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
    • _
    typestringThe type of file you uploaded.

    Possible values:
    • customer_photo (Individual and sole proprietorship)
    • gst_certificate (Sole proprietorship only)
    • fssai_registration (Sole proprietorship only)
    • shop_and_establishment_license (Sole proprietorship only)
    • udyam_registration (Sole proprietorship only)
    • udyog_aadhaar (Sole proprietorship only)
    reference_numberstringIdentification number of the document.

    Example: 123456789012345
    date_of_issuestringDate the document was issued.

    Accepted format:YYYY-MM-DD

    Has to be 10 characters.

    Example: 2021-12-31

    Supported characters:
    • 0-9
    • -

    [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.

    ParameterTypeDescription
    latitudefloatLatitude of the device from which the create current account is sent.

    Note:
    • Has to be between -90 and 90.
    • Minimum: 2 decimals
    • Maximum: 14 decimals
    Example: 12.9013

    Supported characters:
    • 0-9
    • .
    longitudefloatLongitude of the device from which the create current 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_addressstringIP address of the device from which the create current 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 object. This object is part of the account.current object.

    ParameterTypeDescription
    idstringUnique 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_numberstringMobile number of the applicant or registered business.

    Has to be 10 digits.

    Example: 9876543210

    Supported characters:
    • 0-9