AppID - Identify Unique Applications for Reporting

Some organizations choose to deploy their ID DataWeb workflows as shared services, where multiple applications are using a common set of APIs. In these cases, it is important to be able to identify which applications are responsible for sending transactions. This is useful for reporting, and also to enable internal chargebacks in organizations.

To do this, you can use the appid field in your API interactions.

AppID

Appid is a unique identifier of a specific application. You can choose any appID you'd like - for example, the name of the application, or an internal identifier. Once you begin using appid in your API integration, you can use it to filter your transactions for reporting and billing.

Notes on usage

  • To use appid in your integration, simply include it as a field in your requests. All endpoints of the Verify API support appid, as covered in the technical documentation.
  • Include appid in all API requests per the documentation.
  • There is no pre-registration of an appID requred. The value you send will be available as a filter immediately.

Using AppID as a Filter for Reporting

  • Once you begin using appid, you can begin filtering your reports using this value. This is available for all ID DataWeb reports, as covered here.
  • For example, on the transaction report, you can filter by an appid to see only transactions coming from that application.

Billing

  • If you'd like to get your bill split up by AppID, please talk to your account manager.
  • This will allow you to recieve your bill grouped by appid, which can help teams determine which applications were responsible for transactions. This is very useful to support internal chargeback models for enterprise deployments.