CAPP | API

Running a CAPP check on an existing Entity

You can perform a CAPP check on an existing Entity via the POST /api/v2/ci/entities/{entityId}/data-checks/CAPP endpoint.

You must specify an entityId as part of this request.

As part of your request you must specify a request body, such as:

{

  "checkReference": "string",

  "enableOngoingMonitoring": true,

  "ongoingMonitorPeriodType": 0,

  "ongoingMonitorPeriod": 0

}

enableOngoingMonitoring specifies where Ongoing Monitoring should be turned on for the individual that the CAPP report is being run against.

ongoingMonitoringPeriodType specifies the type of time period that Ongoing Monitoring should be enabled for (0=days, 1=weeks, 2=months, 3=years, 4=until cancelled.

ongoingMonitoringPeriod specifies the number of the time periods that Ongoing Monitoring should be enabled for.

For example,

  "enableOngoingMonitoring": true,

  "ongoingMonitorPeriodType": 2,

  "ongoingMonitorPeriod": 6

Would enable Ongoing Monitoring for a period of 6 months after running the check.

You can also provide a Boolean parameter for "includeData" which dictates whether the Address check and International Screen check results are returned in the response object.

Running a CAPP check on a new Entity

You can also create a new Entity and immediately run a CAPP check against them via the POST /api/v2/ci/data-checks/CAPP endpoint.  Here you will need to provide the details for the Entity such as shown below:

{

  "checkReference": "string",

  "enableOngoingMonitoring": true,

  "ongoingMonitorPeriodType": 0,

  "ongoingMonitorPeriod": 0,

  "firstName": "string",

  "middleName": "string",

  "surname": "string",

  "dateOfBirth": "2024-03-12T13:21:59.209Z",

  "addressLine1": "string",

  "addressLine2": "string",

  "city": "string",

  "county": "string",

  "postcode": "string",

  "reference": "string"

}

Response body

This is a synchromous routine, so the response you receive will contain the result and any accompanying remarks.

Please refer to the schema for this endpoint on our Swagger page for details of each Enum value.