Run a verification for a representative
1 min
POST
https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}
Path Parameters
- uuidstringrequiredDescription
- typestringrequiredDescriptionAllowedid3
Responses
201
- object
- dataPersonVerificationsResourceResponse
- typestring<idv | id3 | digital_foot_print>requiredDescriptionAllowedidvid3digital_foot_print
- providerstring<id_scan | yoti | risk_seal | id3>requiredDescriptionAllowedid_scanyotirisk_sealid3
- infoobjectrequiredDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
202
401
- object
- messagestringDescription
404
- object
- messagestringDescription
422
- object
- messagestringDescription
- example_fieldstring[]Description
429
- object
- messagestringDescription
curl
curl --request POST \
--url https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/representatives/{uuid}/verifications/{type}", 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}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
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}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Created. The verification has completed and the result is in the response.
{
"data": {
"type": "",
"provider": "",
"info": {}
}
}202
// Accepted. The verification has started but has not completed. Retrieve the result later with GET /representatives/{uuid}/verifications.
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": ""
}422
// Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.
{
"message": "",
"example_field": [
""
]
}429
// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.
{
"message": ""
}