v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Monitoring

Subscribe a customer or business to monitoring

This endpoint is rarely needed. Since August 2022, watchlist monitoring is automatically enabled for all businesses and customers who are verified (KYC/KYB) through Synctera's platform.

post/monitoring/subscriptions

Request body

business_idstring uuid

Unique ID for the business. Exactly one of business_id or person_id must be set.

creation_timestring date-time

The date and time the resource was created.

idstring uuid

Unique identifier for this subscription.

last_updated_timestring date-time

The date and time the resource was last update.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_idstring uuid

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example request

{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Response

The new monitoring subscription.