{
  "opencollection": "1.0.0",
  "info": {
    "name": "Core V2 Audit Individual Documents API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api_key",
      "value": "{{api_key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Individual Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all documents for an entity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.uat.frankie.one/v2/individuals/:entityId/documents",
            "headers": [
              {
                "name": "api_key",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerID",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerChildID",
                "value": ""
              },
              {
                "name": "X-Frankie-Channel",
                "value": ""
              },
              {
                "name": "X-Frankie-Username",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Unique FrankieOne identifier for an entity"
              },
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "Determines what level of detail to return in the response\n - id: Return just an id\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and data in base64 format"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Get all documents for an entity."
        },
        {
          "info": {
            "name": "Create a new document for an individual.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.uat.frankie.one/v2/individuals/:entityId/documents",
            "headers": [
              {
                "name": "api_key",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerID",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerChildID",
                "value": ""
              },
              {
                "name": "X-Frankie-Channel",
                "value": ""
              },
              {
                "name": "X-Frankie-Username",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Unique FrankieOne identifier for an entity"
              },
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "Determines what level of detail to return in the response\n - id: Return just an id\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and data in base64 format"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Add a new document to an entity."
        },
        {
          "info": {
            "name": "Get a single document by it's id.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.uat.frankie.one/v2/individuals/:entityId/documents/:documentId",
            "headers": [
              {
                "name": "api_key",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerID",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerChildID",
                "value": ""
              },
              {
                "name": "X-Frankie-Channel",
                "value": ""
              },
              {
                "name": "X-Frankie-Username",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Unique FrankieOne identifier for an entity"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a document"
              },
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "Determines what level of detail to return in the response\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and images as base64"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Get a single document by it's id."
        },
        {
          "info": {
            "name": "Update a single document by it's id.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.uat.frankie.one/v2/individuals/:entityId/documents/:documentId",
            "headers": [
              {
                "name": "api_key",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerID",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerChildID",
                "value": ""
              },
              {
                "name": "X-Frankie-Channel",
                "value": ""
              },
              {
                "name": "X-Frankie-Username",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Unique FrankieOne identifier for an entity"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a document"
              },
              {
                "name": "level",
                "value": "",
                "type": "query",
                "description": "Determines what level of detail to return in the response\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and images as base64"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Update document by id."
        },
        {
          "info": {
            "name": "Delete a document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.uat.frankie.one/v2/individuals/:entityId/documents/:documentId",
            "headers": [
              {
                "name": "api_key",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerID",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerChildID",
                "value": ""
              },
              {
                "name": "X-Frankie-Channel",
                "value": ""
              },
              {
                "name": "X-Frankie-Username",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Unique FrankieOne identifier for an entity"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a document"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Delete a single document and all of it's attachments."
        },
        {
          "info": {
            "name": "Delete an attachment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.uat.frankie.one/v2/individuals/:entityId/documents/:documentId/attachments/:attachmentId",
            "headers": [
              {
                "name": "api_key",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerID",
                "value": ""
              },
              {
                "name": "X-Frankie-CustomerChildID",
                "value": ""
              },
              {
                "name": "X-Frankie-Channel",
                "value": ""
              },
              {
                "name": "X-Frankie-Username",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Unique FrankieOne identifier for an entity"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a document"
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "header"
            }
          },
          "docs": "Delete an attachment from a given document."
        }
      ]
    }
  ],
  "bundled": true
}