API reference

Monitoring subscriptions

Re-screening and company events after the verification is complete.

List monitoring subscriptions

GET/v1/monitoring-subscriptions

Scopes: monitoring:read

Parameters

Field	Type	Required
`cursor`query	`string`	no
`limit`query	`integer`	no

Responses

200MonitoringList
400
401
403
404
409
412
413
415
422
428
429
503

Create a monitoring subscription

POST/v1/monitoring-subscriptions

Scopes: monitoring:write
Required header: Idempotency-Key

Request body`MonitoringCreate`

Field	Type	Required
`applicant_id`	`string (uuid)`	yes
`policy_version_id`	`string (uuid)`	yes
`source_ids`	`array of string`	yes
`kyb`	`MonitoringKyb`	no
`basis_record_id`	`string (uuid)`	yes
`frequency`	`enum: daily, weekly, monthly`	yes
`expires_at`	`string (date-time)`	yes
`reverification`	`MonitoringReverification`	no

Responses

201Monitoring
400
401
403
404
409
412
413
415
422
428
429
503

Cancel monitoring

POST/v1/monitoring-subscriptions/{subscription_id}/cancel

Scopes: monitoring:write
Required header: Idempotency-Key
Required header: If-Match

Parameters

Field	Type	Required
`subscription_id`path	`string (uuid)`	yes

Request body`ReasonAction`

Field	Type	Required
`reason_code`	`string`	yes
`note`	`string`	no

Responses

200Monitoring
400
401
403
404
409
412
413
415
422
428
429
503