Synctera · Schema

watchlist_subscription

FinTechBaaSBankingPaymentsCard IssuingKYC

Properties

Name Type Description
auto_renew boolean Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).
created string When this subscription was created
customer_consent boolean Whether this customer has consented to being enrolled for watchlist monitoring
id string Unique identifier for this subscription
period_end string The date when monitoring of this individual should end.
period_start string The date when monitoring of this individual should begin (default: today).
provider_subscription_id string External provider subscription id
status string
View JSON Schema on GitHub

JSON Schema

synctera-watchlist-subscription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/watchlist_subscription",
  "title": "watchlist_subscription",
  "properties": {
    "auto_renew": {
      "description": "Whether this subscription should automatically renew when the subscription period is over (default: vendor-dependent).\n",
      "type": "boolean"
    },
    "created": {
      "description": "When this subscription was created",
      "format": "date-time",
      "type": "string"
    },
    "customer_consent": {
      "description": "Whether this customer has consented to being enrolled for watchlist monitoring\n",
      "type": "boolean"
    },
    "id": {
      "description": "Unique identifier for this subscription",
      "format": "uuid",
      "type": "string"
    },
    "period_end": {
      "description": "The date when monitoring of this individual should end.",
      "format": "date",
      "type": "string"
    },
    "period_start": {
      "description": "The date when monitoring of this individual should begin (default: today).",
      "format": "date",
      "type": "string"
    },
    "provider_subscription_id": {
      "description": "External provider subscription id",
      "type": "string"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    }
  },
  "required": [
    "customer_consent"
  ],
  "type": "object"
}