{
  "opencollection": "1.0.0",
  "info": {
    "name": "Syntage Accounts Payable Insight Background Checks API",
    "version": "2020-06-28"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-Key",
      "value": "{{X-API-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Background Checks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List background checks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syntage.com/background-checks",
            "params": [
              {
                "name": "id[lt]",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "query",
                "description": "Collection cursor pointer to the next page"
              },
              {
                "name": "id[gt]",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "query",
                "description": "Collection cursor pointer to the previous page"
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items per page"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter background checks by status"
              },
              {
                "name": "country",
                "value": "",
                "type": "query",
                "description": "Filter background checks by country"
              },
              {
                "name": "order[score]",
                "value": "",
                "type": "query",
                "description": "Order by background check score"
              },
              {
                "name": "order[createdAt]",
                "value": "",
                "type": "query",
                "description": "Order by resource creation date"
              },
              {
                "name": "order[updatedAt]",
                "value": "",
                "type": "query",
                "description": "Order by resource update date"
              }
            ]
          },
          "docs": "Lists background checks available to the organization. Use filters to narrow the list by processing status, country scope, or score.\n"
        },
        {
          "info": {
            "name": "Retrieve a background check",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syntage.com/background-checks/:id",
            "params": [
              {
                "name": "id",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves one background check, including its score, processing status, country scope, associated files, and links to related records.\n"
        },
        {
          "info": {
            "name": "Download background check PDF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syntage.com/background-checks/:id/pdf",
            "params": [
              {
                "name": "id",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "path"
              }
            ]
          },
          "docs": "Downloads the generated PDF report for a background check. The response body is the PDF file itself.\n"
        },
        {
          "info": {
            "name": "List an entity's background checks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syntage.com/entities/:entityId/background-checks",
            "params": [
              {
                "name": "entityId",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "path"
              },
              {
                "name": "id[lt]",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "query",
                "description": "Collection cursor pointer to the next page"
              },
              {
                "name": "id[gt]",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "query",
                "description": "Collection cursor pointer to the previous page"
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items per page"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter background checks by status"
              },
              {
                "name": "country",
                "value": "",
                "type": "query",
                "description": "Filter background checks by country"
              },
              {
                "name": "order[score]",
                "value": "",
                "type": "query",
                "description": "Order by background check score"
              },
              {
                "name": "order[createdAt]",
                "value": "",
                "type": "query",
                "description": "Order by resource creation date"
              },
              {
                "name": "order[updatedAt]",
                "value": "",
                "type": "query",
                "description": "Order by resource update date"
              }
            ]
          },
          "docs": "Lists background checks associated with an entity. Use this endpoint when your integration is working from a known entity ID.\n"
        },
        {
          "info": {
            "name": "List background check records",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.syntage.com/background-checks/:backgroundCheckId/records",
            "params": [
              {
                "name": "backgroundCheckId",
                "value": "91ab5678-1234-5678-9abc-def012345678",
                "type": "path",
                "description": "The background check ID"
              },
              {
                "name": "id[lt]",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "query",
                "description": "Collection cursor pointer to the next page"
              },
              {
                "name": "id[gt]",
                "value": "91106968-1abd-4d64-85c1-4e73d96fb997",
                "type": "query",
                "description": "Collection cursor pointer to the previous page"
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items per page"
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Filter background check records by category"
              },
              {
                "name": "order[createdAt]",
                "value": "",
                "type": "query",
                "description": "Order by resource creation date"
              },
              {
                "name": "order[updatedAt]",
                "value": "",
                "type": "query",
                "description": "Order by resource update date"
              }
            ]
          },
          "docs": "Lists the records found during a background check. Records contain the detailed source data behind the check and are organized by category and database.\n"
        }
      ]
    }
  ],
  "bundled": true
}