Report Addresses

Represents candidate reported addresses on a Report.

Operations

List existing Report addresses

This request is used to retrieve addresses for a given Report.

Security

basic_auth

report_idstringrequired

Returns the list of Report addresses for the input report_id.

pagenumber or null

Specifies the page number to retrieve.

per_pagenumber or null

Indicates how many records each page should contain. The default value is 25 records.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{report_id}/addresses?page=0&per_page=0'

List of Report addresses

Bodyapplication/json

dataArray of objects(ReportAddresses)

objectstring

A list

Value:"list"

countinteger

Example:1

Response

{
  "data": [
    { … }
  ],
  "object": "list",
  "count": 1
}