API Docs

Create Current Account

post
https://api.zwitch.io/v1/accounts

Use this API to create a current account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Note

When testing this API using your sandbox API keys, always pass the title as:

  • mr
  • dr
  • master
  • prof

This is because, in sandbox mode, the gender returned in the Aadhaar Verification API is always male

📘

Test Data

The table below lists the various PANs you can use to mock different statuses in the Current Account API.

PANStatus
TSKYC1111Kfull_kyc_pending
OPENT1122Sfailed
Body Params
string
required
Defaults to current

The type of account you want to create.

Accepted value current.

string
required

Use only when creating a current account for an individual or sole proprietorship.

Applicant's title.

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

Example: dr

string
required

Name of the applicant or the registered business.

Maximum 70 characters.

Example: Anil Reddy Enterprises

Supported characters:

  • A-Z
  • a-z
  • 0-9
  • .
  • /
  • \
  • -
  • _
  • ,
  • (
  • )
  • '

string
required

Mobile number of the applicant or the registered business.

Has to be 10 digits.

Example: 9876543210

Supported characters:

  • 0-9

string
required

Email address of the applicant or the registered business.

Example: [email protected]

string
required
Defaults to sbm_bank

Bank where the current account is created.

Possible value: sbm_bank

kyc
object
required

Object to pass KYC details of the applicant or registered business.

addresses
array of objects
required

Array of objects to pass the communication address of the applicant or registered business.

addresses*
documents
array of objects
required

Array of objects upload documents required to open a current account.

Use the Upload Document API to upload the required documents.

documents*
device_data
object
required

Object to pass the device details from which the create current account request was received.

nominee
array of objects

Use only when creating a current account for an individual or sole proprietorship.

Array of objects to pass the nominee details.

nominee
metadata
object

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"

Responses

Updated over 2 years ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago

Did this page help you?