---
updatedAt: 2025-02-14T20:04:12.000Z
agentTools:
  projectIndex: https://developer-platform.vibes.com/llms.txt
---

# Wallet Instance Extract

The daily Wallet Instance Extract is used to sync Wallet data between Vibes Platform and a Customer Relationship Management (CRM) or Campaign Management system. It will contain all the Wallet instances that have been registered or unregistered since the last data extract.

# Standard File Name

*The following is the recommended best practice for file names. File naming conventions may be changed upon request.*

`walletinstance_<company_key>_<date>.<extension>`

# How to Read Files

Extract files will be delivered in tab-separated value (TSV) text files. The information is separated into rows and columns. Column data will be separated by tabs, while each new row will be separated by a hard return.

# Contents of Each File

Each file will contain the subscription activity for each day. To help you understand a few common scenarios, below are a few examples:

**If wallet object is registered on 4/5/2017:**

| wallet\_instance\_uid                           | instance\_event | registered\_at          | unregistered\_at | wallet\_object\_uid                 | wallet\_provider | Platform | company\_id | campaign\_uid | uuid          | current\_flag | shared\_instance |
| :---------------------------------------------- | :-------------- | :---------------------- | :--------------- | :---------------------------------- | :--------------- | :------- | :---------- | :------------ | :------------ | :------------ | :--------------- |
| 111b2c1234d1e1234567f123456789abcdefghijk123456 | registered      | 2017-04-05 14:30:00 UTC |                  | AB123B23-45CA-56D1-EF7G-HIJK89012BZ | Pass             | iOS      | A2bc3dFg    | z1a2a-123a    | 123456a1-b001 | TRUE          | FALSE            |

**If wallet object is registered and unregistered on 4/5/2017:**

| wallet\_instance\_uid                           | instance\_event | registered\_at          | unregistered\_at        | wallet\_object\_uid                 | wallet\_provider | Platform | company\_id | campaign\_uid | uuid          | current\_flag | shared\_instance |
| :---------------------------------------------- | :-------------- | :---------------------- | :---------------------- | :---------------------------------- | :--------------- | :------- | :---------- | :------------ | :------------ | :------------ | :--------------- |
| 111b2c1234d1e1234567f123456789abcdefghijk123456 | unregistered    | 2017-04-05 14:30:00 UTC | 2017-04-05 15:30:00 UTC | AB123B23-45CA-56D1-EF7G-HIJK89012BZ | Pass             | iOS      | A2bc3dFg    | z1a2a-123a    | 123456a1-b001 | FALSE         | FALSE            |

**If wallet object is registered and unregistered on 4/5/2017 and the same object is registered again on 4/5/2017:**

| wallet\_instance\_uid                           | instance\_event | registered\_at          | unregistered\_at        | wallet\_object\_uid                 | wallet\_provider | Platform | company\_id | campaign\_uid | uuid          | current\_flag | shared\_instance |
| :---------------------------------------------- | :-------------- | :---------------------- | :---------------------- | :---------------------------------- | :--------------- | :------- | :---------- | :------------ | :------------ | :------------ | :--------------- |
| 111b2c1234d1e1234567f123456789abcdefghijk123456 | unregistered    | 2017-04-05 14:30:00 UTC | 2017-04-05 15:30:00 UTC | AB123B23-45CA-56D1-EF7G-HIJK89012BZ | Pass             | iOS      | A2bc3dFg    | z1a2a-123a    | 123456a1-b001 | FALSE         | FALSE            |
| 111b2c1234d1e1234567f123456789abcdefghijk123456 | registered      | 2017-04-05 16:30:00 UTC |                         | AB123B23-45CA-56D1-EF7G-HIJK89012BZ | Pass             | iOS      | A2bc3dFg    | z1a2a-123a    | 123456a1-b001 | TRUE          | TRUE             |

# File Body

The file body can contain the following fields as data, separated by the delimiter and a header row.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Field Name
      </th>

      <th style={{ textAlign: "left" }}>
        Data Type
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        `wallet_instance_uid`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        Unique Vibes-specific Identifier for each wallet instance that's been installed.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `instance_event`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        Type of wallet instance event. Valid values: **Registered** and **Unregistered**.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `registered_at`
      </td>

      <td style={{ textAlign: "left" }}>
        Date/Time
      </td>

      <td style={{ textAlign: "left" }}>
        The date/time when the wallet object was installed. Format example: "2017-04-05 14:30:00 UTC".
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `unregistered_at`
      </td>

      <td style={{ textAlign: "left" }}>
        Date/Time
      </td>

      <td style={{ textAlign: "left" }}>
        Date/time when the wallet object was uninstalled. Format example: "2017-04-05 14:30:00 UTC".
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `wallet_object_uid`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        Unique identifier for the wallet object of this instance.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `wallet_provider`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        String name for the installed provider. Valid values are **Pass** and **Wallet**.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `platform`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        String for the specified device platform. Example: 'Android 7.1.1', 'iOS 10.3', and so on.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `company_id`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        Unique string representing the id of your Vibes company account.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `campaign_uid`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        Global Unique ID representing the campaign at Vibes.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `uuid`
      </td>

      <td style={{ textAlign: "left" }}>
        String
      </td>

      <td style={{ textAlign: "left" }}>
        This is a campaign-specific identifier that is used to identify wallet objects. This is generally customer defined, as it can be included in links and used before a wallet object is created.

        <br />

        **Note**: `uuid` = `wallet_item_id`
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `current_flag`
      </td>

      <td style={{ textAlign: "left" }}>
        Boolean
      </td>

      <td style={{ textAlign: "left" }}>
        It is **True** if the instance is currently registered, or **False** if the instance has been unregistered.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `shared_instance`
      </td>

      <td style={{ textAlign: "left" }}>
        Boolean
      </td>

      <td style={{ textAlign: "left" }}>
        It is **False** if this the first installed instance for the Wallet object, or **True** otherwise.
      </td>
    </tr>
  </tbody>
</Table>

# Example File

<HTMLBlock>{`
<a href=\"https://vibes.box.com/shared/static/8m29l2i0riy3686tkfgb3uornir0ghg4.txt\" download=\"walletinstance_sample\">Download an example file.</a></li>"
`}</HTMLBlock>