Run a verification for a representative

1 min

POST

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

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.

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 type of verification to run. Currently only <code>id3</code> is supported.

acceptstringGenerated from available response content types

201Created. The verification has completed and the result is in the response.

202Accepted. The verification has started but has not completed. Retrieve the result later with <code>GET /representatives/{uuid}/verifications</code>.

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.

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

429Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.

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

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.