# Create Wallet

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/partner/enKashCard/wallet:
    post:
      summary: Create Wallet
      deprecated: false
      description: >+
        :::highlight purple 📌

        The Create Wallet endpoint allows you to register and initialize a new
        enKash wallet for a user. By submitting the required user details, this
        endpoint creates a dedicated wallet account within the enKash platform

        :::

      tags:
        - Wallet/APIs - Wallet/Wallet Setup
      parameters:
        - name: authorization
          in: header
          description: ''
          required: true
          example: Bearer hxtaSWH8zb5XrA71XDrgFu1uO50
          schema:
            type: string
        - name: partnerId
          in: header
          description: ''
          required: true
          example: CRM338L2H
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: Cookie
          in: header
          description: ''
          required: true
          example: >-
            _cfuvid=jS8C5lxGW4Q6FRWotUQnMGhbxbpGmvk3fGg1kdmq4WM-1752680737979-0.0.1.1-604800000;
            JSESSIONID=6709E31F4515A4151FABAC8E52CAD2A0
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                companyId:
                  type: string
                  description: The unique identifier for the company.
                cardAccountId:
                  type: string
                  description: The identifier for the wallet account.
                email:
                  type: string
                  description: ' The email address of the user.'
                mobile:
                  type: string
                  description: ' The mobile number of the user.'
                title:
                  type: string
                  description: The title of the user (e.g., Mr, Ms).
                firstName:
                  type: string
                  description: The first name of the user.
                lastName:
                  type: string
                  description: The last name of the user.
                gender:
                  type: string
                  description: The gender of the user (e.g., M for male, F for female).
                documents:
                  type: array
                  items:
                    type: object
                    properties:
                      docType:
                        type: string
                        description: The type of document (e.g., PAN).
                      docNo:
                        type: string
                        description: The document number.
                    x-apidog-orders:
                      - docType
                      - docNo
                  description: >-
                    An array of documents required for KYC verification. Each
                    document should include:
                specialDate:
                  type: string
                  description: >-
                    A special date associated with the user DOB (format:
                    DD-MM-YYYY).
                address1:
                  type: string
                  description: Address of user
                address2:
                  type: string
                  description: Address of user
                city:
                  type: string
                  description: City of user
                state:
                  type: string
                  description: State of user
                pincode:
                  type: string
                  description: Pincode of user
                country:
                  type: string
                  description: Country of user
                benefitTemplateId:
                  type: string
                  description: >-
                    Optional : To be provided if sub wallet needs to be created
                    for specific use case.
                clientReferenceId:
                  type: string
                  description: |
                    client reference id of user
                deviceInfo:
                  type: object
                  properties:
                    deviceId:
                      type: string
                      description: Unique identifier
                    appVersion:
                      type: string
                      description: >-
                        Version of the mobile application installed on the
                        device.
                    osVersion:
                      type: string
                      description: Operating system version running on the device.
                    model:
                      type: string
                      description: Device model name as provided by the operating system.
                    manufracture:
                      type: string
                      description: Device manufacturer name.
                    platform:
                      type: string
                      description: Device platform type (e.g., android, ios).
                    simProvider:
                      type: string
                      description: Mobile network operator of the device SIM.
                    deviceIp:
                      type: string
                      description: IP address of the device at the time of request.
                    deviceImei:
                      type: string
                      description: >-
                        International Mobile Equipment Identity (IMEI) of the
                        device.
                  x-apidog-orders:
                    - deviceId
                    - appVersion
                    - osVersion
                    - model
                    - manufracture
                    - platform
                    - simProvider
                    - deviceIp
                    - deviceImei
                  required:
                    - deviceId
                    - appVersion
                    - osVersion
                    - model
                    - manufracture
                    - platform
                    - simProvider
                    - deviceIp
                    - deviceImei
              required:
                - companyId
                - cardAccountId
                - email
                - mobile
                - title
                - firstName
                - lastName
                - gender
                - documents
                - specialDate
                - address1
                - address2
                - city
                - state
                - pincode
                - country
                - deviceInfo
              x-apidog-orders:
                - companyId
                - cardAccountId
                - email
                - mobile
                - title
                - firstName
                - lastName
                - address1
                - address2
                - city
                - state
                - pincode
                - country
                - gender
                - documents
                - specialDate
                - benefitTemplateId
                - clientReferenceId
                - deviceInfo
            example:
              companyId: CEKQ08TRRG
              cardAccountId: CAC7975
              email: krishnatwallet@gmail.com
              mobile: '6000091111'
              title: Mr
              firstName: Kris
              lastName: singh
              documents:
                - docType: PAN
                  docNo: CPNPN9971R
              specialDate: 02-09-2001
              address: Flat 109, near Dmart
              address2: Radha Chowk
              city: Kota
              state: Rajasthan
              pincode: '323307'
              country: India
              clientReferenceId: CLI34562JK
              deviceInfo:
                deviceId: DEVICE_ABC123456
                appVersion: 2.1.0
                osVersion: Android 14
                model: Samsung S23
                manufracture: Samsung
                platform: ANDROID
                simProvider: Airtel
                deviceIp: 192.168.1.10
                deviceImei: '356789123456789'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  payload:
                    type: object
                    properties:
                      enKashCardId:
                        type: string
                      email:
                        type: string
                      mobile:
                        type: string
                      title:
                        type: string
                      firstName:
                        type: string
                      lastName:
                        type: string
                      gender:
                        type: string
                      specialDate:
                        type: string
                      address:
                        type: string
                      address2:
                        type: string
                      city:
                        type: string
                      state:
                        type: string
                      country:
                        type: string
                      pincode:
                        type: string
                      otbBalance:
                        type: integer
                      createdOn:
                        type: string
                      modifiedOn:
                        type: string
                      cardStatus:
                        type: object
                        properties:
                          name:
                            type: string
                          label:
                            type: string
                        required:
                          - name
                          - label
                        x-apidog-orders:
                          - name
                          - label
                      kycStatus:
                        type: object
                        properties:
                          name:
                            type: string
                          label:
                            type: string
                        required:
                          - name
                          - label
                        x-apidog-orders:
                          - name
                          - label
                        description: 'kyc status of wallet '
                      blockCode:
                        type: string
                      cardActivated:
                        type: boolean
                        description: wallet is activated
                      companyId:
                        type: string
                      subWalletBalance:
                        type: string
                        description: >-
                          Sub wallet balance (to be considered for only cases
                          which involve sub wallet creation)
                      benefitTemplateId:
                        type: string
                        description: >-
                          The template id provided in request for sub wallet
                          creation
                      enkashCardBenefitId:
                        type: string
                        description: |
                          Sub wallet Card Id
                      01KAK4DR9ZFQ8XB68E5SX6A4T6:
                        type: string
                      clientReferenceId:
                        type: string
                        description: |
                          client Reference id
                    required:
                      - enKashCardId
                      - email
                      - mobile
                      - title
                      - firstName
                      - lastName
                      - gender
                      - specialDate
                      - address
                      - address2
                      - city
                      - state
                      - country
                      - pincode
                      - otbBalance
                      - createdOn
                      - modifiedOn
                      - cardStatus
                      - kycStatus
                      - blockCode
                      - cardActivated
                      - companyId
                      - benefitTemplateId
                      - subWalletBalance
                      - enkashCardBenefitId
                      - clientReferenceId
                    x-apidog-orders:
                      - enKashCardId
                      - email
                      - mobile
                      - title
                      - firstName
                      - lastName
                      - gender
                      - specialDate
                      - address
                      - address2
                      - city
                      - state
                      - country
                      - pincode
                      - otbBalance
                      - createdOn
                      - modifiedOn
                      - cardStatus
                      - kycStatus
                      - blockCode
                      - cardActivated
                      - companyId
                      - benefitTemplateId
                      - subWalletBalance
                      - enkashCardBenefitId
                      - clientReferenceId
                      - 01KAK4DR9ZFQ8XB68E5SX6A4T6
                required:
                  - code
                  - message
                  - payload
                x-apidog-orders:
                  - code
                  - message
                  - payload
              example:
                code: 0
                message: Success
                payload:
                  enKashCardId: EKCWLUAADN
                  cardAccountId: CAC7975
                  title: Mr
                  firstName: Kris
                  lastName: Singh
                  otbBalance: 0
                  cardStatus:
                    name: UL
                    label: UnLocked
                  kycStatus:
                    name: NOT_UPLOADED
                    label: Not Uploaded
                  partnerTncUrl: string
          headers: {}
          x-apidog-name: OK
      security:
        - bearer: []
      x-apidog-folder: Wallet/APIs - Wallet/Wallet Setup
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-19199846-run
components:
  schemas: {}
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```
