> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-api-docs/api-reference/representatives/verifications.md).

# Verifications

Identity and other verifications carried out on a representative. Run a verification, list the verifications held for a representative with each provider's result, and download the IDV report.

## Run a verification for a representative

> Runs a verification for a representative. Currently the supported type is \`id3\`.\
> \
> Each type of verification can use different providers, and the data returned under the \`info\` key is specific to the provider. The examples show what a response might look like, but the structure and content of this data are determined by the external providers and may change without notice.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Representative Verifications","description":"Identity and other verifications carried out on a representative. Run a verification, list the verifications held for a representative with each provider's result, and download the IDV report."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"representativeUuid":{"name":"uuid","in":"path","description":"UUID of the representative.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"PersonVerificationsResourceResponse":{"title":"Representative Verifications Resource Response","required":["type","info","provider"],"properties":{"type":{"description":"The type of verification.","type":"string","enum":["idv","id3","digital_foot_print"],"nullable":false},"provider":{"description":"The provider that carried out the verification.","type":"string","enum":["id_scan","yoti","risk_seal","id3"],"nullable":false},"info":{"description":"The provider's result. Its structure depends on the provider and may change without notice.","type":"object","nullable":false,"additionalProperties":true}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"422":{"description":"Unprocessable Content. The request was understood but failed validation. `errors` lists each field that failed and why.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A human-readable description of the first error.","type":"string"},"errors":{"description":"Validation errors, keyed by the name of the field that failed. Each field has a list of messages.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/representatives/{uuid}/verifications/{type}":{"post":{"tags":["Representative Verifications"],"summary":"Run a verification for a representative","description":"Runs a verification for a representative. Currently the supported type is `id3`.\n\nEach type of verification can use different providers, and the data returned under the `info` key is specific to the provider. The examples show what a response might look like, but the structure and content of this data are determined by the external providers and may change without notice.","operationId":"23e6a472f7620ff377b8f20a666a29e2","parameters":[{"$ref":"#/components/parameters/representativeUuid"},{"name":"type","in":"path","description":"The type of verification to run. Currently only `id3` is supported.","required":true,"schema":{"type":"string","enum":["id3"]}}],"responses":{"201":{"description":"Created. The verification has completed and the result is in the response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/PersonVerificationsResourceResponse"}},"type":"object"}}}},"202":{"description":"Accepted. The verification has started but has not completed. Retrieve the result later with **List representative verifications** (`GET /representatives/{uuid}/verifications`)."},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"}}}}}}
```

## List representative verifications

> Returns the verifications held for a representative. Each item shows the verification \`type\`, the \`provider\` that carried it out, and the provider's result under \`info\`.\
> \
> The verification types are:\
> \
> \- \`idv\`: identity verification, using an ID document and biometric checks\
> \- \`id3\`: an electronic identity (eKYC) check of the representative's details against data sources\
> \- \`digital\_foot\_print\`: a digital footprint check\
> \
> Each type of verification can use different providers, and the data returned under the \`info\` key is specific to the provider. The examples show what a response might look like, but the structure and content of this data are determined by the external providers and may change without notice.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Representative Verifications","description":"Identity and other verifications carried out on a representative. Run a verification, list the verifications held for a representative with each provider's result, and download the IDV report."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"representativeUuid":{"name":"uuid","in":"path","description":"UUID of the representative.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"PersonVerificationsResourceResponse":{"title":"Representative Verifications Resource Response","required":["type","info","provider"],"properties":{"type":{"description":"The type of verification.","type":"string","enum":["idv","id3","digital_foot_print"],"nullable":false},"provider":{"description":"The provider that carried out the verification.","type":"string","enum":["id_scan","yoti","risk_seal","id3"],"nullable":false},"info":{"description":"The provider's result. Its structure depends on the provider and may change without notice.","type":"object","nullable":false,"additionalProperties":true}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/representatives/{uuid}/verifications":{"get":{"tags":["Representative Verifications"],"summary":"List representative verifications","description":"Returns the verifications held for a representative. Each item shows the verification `type`, the `provider` that carried it out, and the provider's result under `info`.\n\nThe verification types are:\n\n- `idv`: identity verification, using an ID document and biometric checks\n- `id3`: an electronic identity (eKYC) check of the representative's details against data sources\n- `digital_foot_print`: a digital footprint check\n\nEach type of verification can use different providers, and the data returned under the `info` key is specific to the provider. The examples show what a response might look like, but the structure and content of this data are determined by the external providers and may change without notice.","operationId":"d49cb5421a3d7f6d3dcd55f826aab59d","parameters":[{"$ref":"#/components/parameters/representativeUuid"},{"name":"type","in":"query","description":"Filter by verification type. To filter by more than one type, separate the types with commas, for example `idv,id3`.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"description":"The verifications held for the representative.","type":"array","items":{"$ref":"#/components/schemas/PersonVerificationsResourceResponse"}}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}}}}
```

## Download the IDV report for a representative

> 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\`.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Representative Verifications","description":"Identity and other verifications carried out on a representative. Run a verification, list the verifications held for a representative with each provider's result, and download the IDV report."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"representativeUuid":{"name":"uuid","in":"path","description":"UUID of the representative.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"422":{"description":"Unprocessable Content. The request was understood but failed validation. `errors` lists each field that failed and why.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A human-readable description of the first error.","type":"string"},"errors":{"description":"Validation errors, keyed by the name of the field that failed. Each field has a list of messages.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}}},"paths":{"/representatives/{uuid}/verifications/{type}/report":{"get":{"tags":["Representative Verifications"],"summary":"Download the IDV report for a representative","description":"Downloads the identity verification (IDV) report for a representative, as a ZIP file containing a single `report.pdf` generated by the IDV provider.\n\n### Constraints\n\n- Only `idv` is supported as the `{type}` path parameter.\n- Only representatives verified with the `id_scan` provider support report downloads.\n- 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`.","operationId":"6db9dab8c81d68149f163b8b9395f24c","parameters":[{"$ref":"#/components/parameters/representativeUuid"},{"name":"type","in":"path","description":"The verification type to download the report for. Currently only `idv` is supported.","required":true,"schema":{"type":"string","enum":["idv"]}}],"responses":{"200":{"description":"OK. The response body is a ZIP file containing the IDV report.","headers":{"Content-Type":{"description":"MIME type returned by the IDV provider. Falls back to `application/octet-stream` when the provider does not return one.","schema":{"type":"string"}},"Content-Disposition":{"description":"Download disposition returned by the IDV provider. Falls back to `attachment` when the provider does not return one.","schema":{"type":"string"}},"Content-Length":{"description":"File size in bytes when provided by the IDV provider.","schema":{"type":"integer"}},"Cache-Control":{"description":"Prevents clients and intermediaries from storing the report.","schema":{"type":"string"}},"Pragma":{"description":"Legacy no-cache directive.","schema":{"type":"string"}},"Expires":{"description":"Legacy cache expiry directive.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"Prevents MIME type sniffing.","schema":{"type":"string"}}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"410":{"description":"Gone. The report is no longer available because the 31 day retention period has passed.","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://detected.gitbook.io/detected-api-docs/api-reference/representatives/verifications.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.