{
  "opencollection": "1.0.0",
  "info": {
    "name": "Rentberry Screening API",
    "version": "4"
  },
  "items": [
    {
      "info": {
        "name": "Screening",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get homeowner screening requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/screening",
            "params": [
              {
                "name": "active",
                "value": "",
                "type": "query",
                "description": "Filter by active status"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Items per page"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns paginated list of screening requests created by the authenticated homeowner."
        },
        {
          "info": {
            "name": "Create screening requests",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/screening",
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Creates screening requests for one or more tenants and sends email invitations."
        },
        {
          "info": {
            "name": "Get screening request by reference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v:version/screening/:reference",
            "params": [
              {
                "name": "reference",
                "value": "",
                "type": "path",
                "description": "Unique reference code"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Returns screening request details using reference code from email invitation."
        },
        {
          "info": {
            "name": "Resend screening request email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/screening/resend/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Screening request ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Resends email invitation to tenant for an existing screening request."
        },
        {
          "info": {
            "name": "Cancel screening request",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v:version/screening/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Screening request ID"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Available since API version 1. Cancels an active screening request. Cannot cancel completed or paid requests."
        },
        {
          "info": {
            "name": "Pay for screening (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/screening/screen/:reference/pay",
            "params": [
              {
                "name": "reference",
                "value": "",
                "type": "path",
                "description": "Screening reference code"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. DEPRECATED: Use Stripe webhook instead. Associates feature ticket with screening request."
        },
        {
          "info": {
            "name": "Validate tenant data for screening",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/screening/validate/:reference",
            "params": [
              {
                "name": "reference",
                "value": "",
                "type": "path",
                "description": "Screening reference code"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Validates tenant personal information before performing actual screening."
        },
        {
          "info": {
            "name": "Perform tenant screening",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v:version/screening/screen/:reference",
            "params": [
              {
                "name": "reference",
                "value": "",
                "type": "path",
                "description": "Screening reference code"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Available since API version 1. Executes credit and criminal background screening for tenant using validated data."
        }
      ]
    }
  ],
  "bundled": true
}