Download the IDV report for a representative

1 min

GET

https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report

Downloads the identity verification (IDV) report for a representative, as a ZIP file containing a single report.pdf generated by the IDV provider.

Constraints

Only idv is supported as the {type} path parameter.
Only representatives verified with the id_scan provider support report downloads.
Reports are available for 31 days from the date of the IDV record. After that, the provider deletes the underlying data and the endpoint returns 410 Gone.

uuidstringUUID of the item named in the path, for example the profile in <code>/profiles/{uuid}</code> or the representative in <code>/representatives/{uuid}</code>.

typestringThe verification type to download the report for. Currently only <code>idv</code> is supported.

acceptstringGenerated from available response content types

200OK. The response body is a ZIP file containing the IDV report.

401Unauthorized. The access token is missing, invalid or has expired.

404Not Found. The requested resource does not exist, or is not available to your account.

410Gone. The report is no longer available because the 31 day retention period has passed.

422Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.

curl --request GET \
     --url https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}/report \
     --header 'accept: application/octet-stream'

Have a question?

Our knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.