Create a Monitoring Subscription

POST 
/v1/monitoring-subscriptions

Create a Monitoring Subscription

Request

Header Parameters

Idempotency-Key string

Idempotency key

application/json

Body

required

oneOf

MOD1

organisationIdstringrequired

MOD2

validationRequestIdstringrequired

Responses

200

Successfully created a Monitoring Subscription

application/json

Schema

Schema

data

object

idstring

Example: monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

statusstring

Possible values: [live, pending_validation_request, validation_request_failed, pending, cancelled]

Example: live

configurationIdstring

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

results

object

complianceStatusstringnullable

Possible values: [pass, fail]

Example: fail

registration

object

activestring

Possible values: [yes, no]

Example: no

warning

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

sanction

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

controversial

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

commercial

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

adverseMedia

object

nullable

statusstring

Possible values: [clear, flag]

Example: clear

hateSpeech

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

organisation

object

namestringnullable

Example: Name of the organisation the Monitoring Subscription is attached to
objectstring
Example: monitoring_subscription

Example (from schema)

{
  "data": {
    "id": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "live",
    "configurationId": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "results": {
      "complianceStatus": "fail",
      "registration": {
        "active": "no"
      },
      "warning": {
        "status": "flag"
      },
      "sanction": {
        "status": "flag"
      },
      "controversial": {
        "status": "flag"
      },
      "commercial": {
        "status": "flag"
      },
      "adverseMedia": {
        "status": "clear"
      },
      "hateSpeech": {
        "status": "flag"
      }
    },
    "createdAt": "2020-10-13T17:46:54.000Z",
    "organisation": {
      "name": "Name of the organisation the Monitoring Subscription is attached to"
    }
  },
  "object": "monitoring_subscription"
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

EntityNotFound

Subscription Entity Not Found

{
  "error": {
    "code": "monitoring_subscription/entity_not_found",
    "title": "Bad request",
    "message": "Organisation or validation request was not found"
  }
}

OrganisationNotActive

400 Bad request

{
  "error": {
    "code": "monitoring_subscription/organisation_not_active",
    "title": "Bad request",
    "message": "Organisation is not active"
  }
}

BadRequest

400 Bad Request

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "Something is wrong with your request, please check any parameters and try again"
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

OriginalCallInProgress

Idempotency - Original call in progress

{
  "error": {
    "code": "idempotency/original_call_in_progress",
    "title": "Bad request",
    "message": "Original call with this idempotency key is still in progress"
  }
}

SameKeyDifferentData

Idempotency - Data has changed from previous request

{
  "error": {
    "code": "idempotency/same_key_different_data",
    "title": "Bad request",
    "message": "Data has changed from previous request"
  }
}

KeyInUse

Idempotency - Key in use

{
  "error": {
    "code": "idempotency/key_already_in_use",
    "title": "Bad request",
    "message": "Idempotency Key is already in use"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}