---
agentTools:
  projectIndex: https://ownli.readme.io/llms.txt
---

# List all Proof of address check-ins.

Retrieve the list of proof of address check-ins of all users owned by a partner.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPI definition",
    "version": "v0"
  },
  "servers": [
    {
      "url": "https://api.sandbox.ownli.app",
      "description": "Generated server url"
    }
  ],
  "paths": {
    "/api/checkins/proof-of-address": {
      "get": {
        "tags": [
          "Admin"
        ],
        "summary": "List all Proof of address check-ins.",
        "description": "Retrieve the list of proof of address check-ins of all users owned by a partner.",
        "operationId": "getCheckins_1",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Page number",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            },
            "example": 0
          },
          {
            "name": "size",
            "in": "query",
            "description": "Number of items per page",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            },
            "example": 10
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Sort by field",
            "required": false,
            "schema": {
              "type": "string",
              "default": "dateCheckedIn",
              "enum": [
                "dateCheckedIn",
                "dateUpdated"
              ]
            },
            "example": "dateCheckedIn"
          },
          {
            "name": "sortDirection",
            "in": "query",
            "description": "Sort by order",
            "required": false,
            "schema": {
              "type": "string",
              "default": "desc",
              "enum": [
                "asc",
                "desc"
              ]
            },
            "example": "desc"
          },
          {
            "name": "searchBy",
            "in": "query",
            "description": "Search by field",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "id",
                "city",
                "state",
                "userFirstName",
                "userLastName",
                "userEmail",
                "userPhone"
              ]
            },
            "example": "userFirstName"
          },
          {
            "name": "searchValue",
            "in": "query",
            "description": "Search by value",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "Tom"
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter proof of address check-ins by status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "Pending",
                "Confirmed",
                "Declined",
                "OnHold",
                "Archived",
                "All"
              ]
            },
            "example": "Pending"
          },
          {
            "name": "isFraud",
            "in": "query",
            "description": "Filter proof of address check-ins marked as fraud.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "checkinStartDate",
            "in": "query",
            "description": "Filter proof of address check-ins whose check-in date is greater or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ) ",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2024-01-01T00:00:00.000Z"
          },
          {
            "name": "checkinEndDate",
            "in": "query",
            "description": "Filter proof of address check-ins whose check-in date is less or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ) ",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2024-01-01T00:00:00.000Z"
          },
          {
            "name": "updatedStartDate",
            "in": "query",
            "description": "Filter proof of address check-ins whose update date is greater or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ) ",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2024-01-01T00:00:00.000Z"
          },
          {
            "name": "updatedEndDate",
            "in": "query",
            "description": "Filter proof of address check-ins whose update date is less or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ) ",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2024-01-01T00:00:00.000Z"
          },
          {
            "name": "partnerId",
            "in": "header",
            "description": "Partner Id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "clientId",
            "in": "header",
            "description": "Client Id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "clientSecret",
            "in": "header",
            "description": "Client Secret",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of Proof of address checkin objects matching given query.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProofOfAddressCheckinPageDto"
                }
              }
            }
          },
          "401": {
            "description": "Authorization error e.g. due to an invalid or missing API keys."
          },
          "500": {
            "description": "Internal error. \nPossible error codes \n1. **INTERNAL_SERVER_ERROR**",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDto"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponseDto": {
        "type": "object",
        "properties": {
          "error_code": {
            "type": "string",
            "description": "Error code"
          },
          "error_message": {
            "type": "string",
            "description": "A verbose error message"
          }
        },
        "description": "Error response."
      },
      "OwnerDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id of the user"
          },
          "firstName": {
            "type": "string",
            "description": "User's first name"
          },
          "lastName": {
            "type": "string",
            "description": "User's last name"
          }
        },
        "description": "Check-in owner"
      },
      "ProofOfAddressAddressDto": {
        "type": "object",
        "properties": {
          "addressLine1": {
            "type": "string",
            "description": "Street Address Line 1"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "2 Letter State Code"
          },
          "country": {
            "type": "string",
            "description": "2 Letter Country Code"
          },
          "zip": {
            "type": "string",
            "description": "Zip"
          },
          "latitude": {
            "type": "number",
            "description": "Latitude at which photo was taken",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude at which photo was taken",
            "format": "double"
          }
        },
        "description": "Address"
      },
      "ProofOfAddressDocumentDto": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL of the document"
          },
          "type": {
            "type": "string",
            "description": "Type of the document.",
            "enum": [
              "DOCUMENT",
              "GALLERY",
              "CAMERA",
              "INVALID",
              "CAMERA",
              "DOCUMENT",
              "GALLERY"
            ]
          },
          "latitude": {
            "type": "number",
            "description": "Latitude at which photo was taken",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude at which photo was taken",
            "format": "double"
          },
          "markedInvalidByReview": {
            "type": "boolean",
            "description": "Indicates that the document has been marked invalid on review."
          }
        },
        "description": "A proof of address check-in document"
      },
      "ProofOfAddressDocumentInsightDto": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string",
            "description": "First name on document(s)"
          },
          "lastName": {
            "type": "string",
            "description": "Last name on document(s)"
          },
          "address": {
            "$ref": "#/components/schemas/ProofOfAddressExtractedAddressDto"
          }
        },
        "description": "Insights gathered from the uploaded document(s)"
      },
      "ProofOfAddressExtractedAddressDto": {
        "type": "object",
        "properties": {
          "addressLine1": {
            "type": "string",
            "description": "Street Address Line 1"
          },
          "addressLine2": {
            "type": "string",
            "description": "Street Address Line 2"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "2 Letter State Code"
          },
          "country": {
            "type": "string",
            "description": "2 Letter Country Code"
          },
          "zip": {
            "type": "string",
            "description": "Zip"
          }
        },
        "description": "Address"
      },
      "ProofOfAddressPhotoDto": {
        "type": "object",
        "properties": {
          "photoUrl": {
            "type": "string",
            "description": "URL of the photo"
          },
          "type": {
            "type": "string",
            "description": "Type of the photo. A value from one of the proof of address checkin photo types.",
            "enum": [
              "FrontView",
              "AlternateView"
            ]
          },
          "latitude": {
            "type": "number",
            "description": "Latitude at which photo was taken",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude at which photo was taken",
            "format": "double"
          },
          "markedInvalidByReview": {
            "type": "boolean",
            "description": "Indicates that the photo has been marked invalid on review."
          }
        },
        "description": "A proof of address check-in photo"
      },
      "ProofOfAddressCheckInListDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id of the checkin"
          },
          "userNote": {
            "type": "string",
            "description": "User generated note. For communication between the user to the admin"
          },
          "adminNote": {
            "type": "string",
            "description": "Admin generated note. Usually used for on-hold or declined check-ins"
          },
          "checkedInAt": {
            "type": "string",
            "description": "Check-in date"
          },
          "checkInStatus": {
            "type": "string",
            "description": "Status of the check-in",
            "enum": [
              "Confirmed",
              "Declined",
              "OnHold",
              "Pending"
            ]
          },
          "updated": {
            "type": "string",
            "description": "Last updated on"
          },
          "address": {
            "$ref": "#/components/schemas/ProofOfAddressAddressDto"
          },
          "documentType": {
            "type": "string",
            "description": "Document Type",
            "enum": [
              "UtilityBill",
              "Paycheck",
              "FinancialStatement",
              "SaleDeed",
              "LeaseAgreement",
              "Invalid"
            ]
          },
          "insights": {
            "$ref": "#/components/schemas/ProofOfAddressDocumentInsightDto"
          },
          "documents": {
            "type": "array",
            "description": "The document(s)",
            "items": {
              "$ref": "#/components/schemas/ProofOfAddressDocumentDto"
            }
          },
          "photos": {
            "type": "array",
            "description": "The photos of the vehicle taken from different angles",
            "items": {
              "$ref": "#/components/schemas/ProofOfAddressPhotoDto"
            }
          },
          "latitude": {
            "type": "number",
            "description": "Latitude at which check-in was done",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude at which check-in was done",
            "format": "double"
          },
          "owner": {
            "$ref": "#/components/schemas/OwnerDto"
          },
          "fraud": {
            "type": "boolean"
          }
        },
        "description": "A proof of address check-in"
      },
      "ProofOfAddressCheckinPageDto": {
        "type": "object",
        "properties": {
          "totalItems": {
            "type": "integer",
            "description": "Total number of proof of address check-ins",
            "format": "int64"
          },
          "currentPage": {
            "type": "integer",
            "description": "Current page number",
            "format": "int32"
          },
          "totalPages": {
            "type": "integer",
            "description": "Current page size",
            "format": "int64"
          },
          "itemsOnPage": {
            "type": "integer",
            "description": "Number of proof of address check-ins on current page",
            "format": "int32"
          },
          "checkins": {
            "type": "array",
            "description": "List of proof of address check-ins",
            "items": {
              "$ref": "#/components/schemas/ProofOfAddressCheckInListDto"
            }
          }
        },
        "description": "Paginated list of proof of address check-ins given by a partner."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 105,
      "1": 149,
      "2": 36,
      "3": 236,
      "4": 14,
      "5": 67,
      "6": 148,
      "7": 138,
      "8": 212,
      "9": 48,
      "10": 246,
      "11": 30
    }
  }
}
```