---
title: Download the IDV report for a representative
slug: andrei/download-the-idv-report-for-a-representative
createdAt: 2026-10-05T10:36:01.732Z
---

{
  "id": "IwUUwrEaMiaS9kDaNQF_v",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report",
    "servers": [
      {
        "url": "https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report",
        "description": "Production"
      }
    ],
    "name": "Download the IDV report for a representative",
    "description": "<p>Downloads the identity verification (IDV) report for a representative, as a ZIP file containing a single <code>report.pdf</code> generated by the IDV provider.</p>\n<h3>Constraints</h3>\n<ul>\n<li>Only <code>idv</code> is supported as the <code>{type}</code> path parameter.</li>\n<li>Only representatives verified with the <code>id_scan</code> provider support report downloads.</li>\n<li>Reports are available for <strong>31 days</strong> from the date of the IDV record. After that, the provider deletes the underlying data and the endpoint returns <code>410 Gone</code>.</li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "uuid",
          "type": "string",
          "description": "<p>UUID of the item named in the path, for example the profile in <code>/profiles/{uuid}</code> or the representative in <code>/representatives/{uuid}</code>.</p>"
        },
        {
          "kind": "required",
          "name": "type",
          "type": "string",
          "description": "<p>The verification type to download the report for. Currently only <code>idv</code> is supported.</p>",
          "enum": [
            "idv"
          ]
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/octet-stream",
            "application/json"
          ],
          "default": "application/octet-stream"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "AccessToken",
          "name": "AccessToken",
          "kind": "optional",
          "type": "http",
          "description": "<p>The API uses OAuth 2.0. Request an access token from <code>POST /oauth/token</code> with the client ID and client secret of your integration client, and your account slug. Send the access token in the <code>Authorization</code> header of every request, in the format <code>Authorization: Bearer &#x3C;access_token></code>. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK. The response body is a ZIP file containing the IDV report.",
        "jsonExample": "",
        "isExpanded": true,
        "headers": [
          {
            "kind": "optional",
            "name": "Content-Type",
            "type": "string",
            "description": "<p>MIME type returned by the IDV provider. Falls back to <code>application/octet-stream</code> when the provider does not return one.</p>"
          },
          {
            "kind": "optional",
            "name": "Content-Disposition",
            "type": "string",
            "description": "<p>Download disposition returned by the IDV provider. Falls back to <code>attachment</code> when the provider does not return one.</p>"
          },
          {
            "kind": "optional",
            "name": "Content-Length",
            "type": "integer",
            "description": "File size in bytes when provided by the IDV provider."
          },
          {
            "kind": "optional",
            "name": "Cache-Control",
            "type": "string",
            "description": "Prevents clients and intermediaries from storing the report."
          },
          {
            "kind": "optional",
            "name": "Pragma",
            "type": "string",
            "description": "<p>Legacy no-cache directive.</p>"
          },
          {
            "kind": "optional",
            "name": "Expires",
            "type": "string",
            "description": "Legacy cache expiry directive."
          },
          {
            "kind": "optional",
            "name": "X-Content-Type-Options",
            "type": "string",
            "description": "Prevents MIME type sniffing."
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The access token is missing, invalid or has expired.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "<p>Not Found. The requested resource does not exist, or is not available to your account.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "410",
        "description": "Gone. The report is no longer available because the 31 day retention period has passed.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "422",
        "description": "Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              },
              {
                "name": "example_field",
                "kind": "optional",
                "type": "array",
                "description": "<p>Validation errors for one field of the request body. The property name is the name of the field that failed validation (<code>example_field</code> is a placeholder).</p>",
                "example": "",
                "itemType": "string",
                "customType": "string[]",
                "itemExample": "",
                "itemDefault": ""
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report \\\n     --header 'accept: application/octet-stream'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/octet-stream\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/octet-stream\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report\"\n\npayload = {}\nheaders = {\n   'accept': 'application/octet-stream',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK. The response body is a ZIP file containing the IDV report.\n"
        },
        {
          "id": "response-1-401",
          "language": "401",
          "code": "// Unauthorized. The access token is missing, invalid or has expired.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-404",
          "language": "404",
          "code": "// Not Found. The requested resource does not exist, or is not available to your account.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-3-410",
          "language": "410",
          "code": "// Gone. The report is no longer available because the 31 day retention period has passed.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-4-422",
          "language": "422",
          "code": "// Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.\n{\n  \"message\": \"\",\n  \"example_field\": [\n    \"\"\n  ]\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}