RejectedRecords

Rejected records are the records which were sent to ZAP POST via the API which have subsequently failed our data cleansing process. Data cleansing is the process of checking the accuracy of records using the Postcode Address File as well as a database of Deceased or Gone Away recipients. Data filtering, PAF check and data cleansing is all included as part of the ZAP~POST process.

get

Authorizations

Bearer

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer 12345abcdef'

Path parameters

submissionIdstring · uuidRequired

Responses

200

Success

application/json

campaignIdstring · uuidOptional

submissionsany · nullableOptional

400

Bad Request

401

Unauthorized

404

Not Found

get

/api/v1/RejectedRecords/{submissionId}

HTTPcURLJavaScriptPython

GET /api/v1/RejectedRecords/{submissionId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "submissions": null
}

Useful information

Cleanse reports are also available via the ZAP APP

As part of the data cleansing process, we provide all clients with a 'Cleanse Report' at the end of each campaign. This report will highlight any records from the original submission that failed a PAF, deceased or gone away check.