Download the IDV report for a representative
1 min
GET
https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report
Path Parameters
- uuidstringrequiredDescription
- typestringrequiredDescriptionAllowedidv
Header Parameters
- acceptstringDescriptionDefaultapplication/octet-streamAllowedapplication/octet-streamapplication/json
Responses
200
Response Headers
- Content-TypestringDescription
- Content-DispositionstringDescription
- Content-LengthintegerDescription
- Cache-ControlstringDescription
- PragmastringDescription
- ExpiresstringDescription
- X-Content-Type-OptionsstringDescription
401
- object
- messagestringDescription
404
- object
- messagestringDescription
410
- object
- messagestring
422
- object
- messagestringDescription
- example_fieldstring[]Description
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report \
--header 'accept: application/octet-stream'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/octet-stream");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/octet-stream"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report"
payload = {}
headers = {
'accept': 'application/octet-stream',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK. The response body is a ZIP file containing the IDV report.
401
// Unauthorized. The access token is missing, invalid or has expired.
{
"message": ""
}404
// Not Found. The requested resource does not exist, or is not available to your account.
{
"message": ""
}410
// Gone. The report is no longer available because the 31 day retention period has passed.
{
"message": ""
}422
// Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.
{
"message": "",
"example_field": [
""
]
}