Create a representative
1 min
POST
https://api.detected.app/api/v2/public/representatives
Body Parameters
- bodyPersonCreateRequest
- nameobjectrequiredDescription
- first_namestringrequiredDescription
- middle_namestringDescription
- last_namestringrequiredDescription
- emailstringrequiredDescription
- titlestring<Mr | Mrs | Ms | Miss | Mx | Dr | Rev>DescriptionAllowedMrMrsMsMissMxDrRev
- profile_idstringrequiredDescription
- review_statusstring<pending | needs_review | verified | rejected | fraud | additional_information | previously_verified>DescriptionAllowedpendingneeds_reviewverifiedrejectedfraudadditional_informationpreviously_verified
- typesstring[]requiredDescription
- dobstringDescription
- role_typestring[]Description
- professional_profilestringDescription
- job_titlestringDescription
- residence_country_codestringDescription
- birth_country_codestringDescription
- nationalitystringDescription
- addressobjectDescription
- apartment_numberstringDescription
- address_1stringDescription
- address_2stringDescription
- citystringDescription
- statestringDescription
- postcodestringDescription
- countrystringDescription
- personal_numberstringDescription
- shareholder_typestring<Direct | Indirect>DescriptionAllowedDirectIndirect
- share_percentagenumberDescription
Responses
201
- object
- dataRepresentativesResource
- idstringrequiredDescription
- profile_idstringrequiredDescription
- customer_referencestringrequiredDescription
- is_companybooleanrequiredDescription
- review_statusobjectDescription
- statusstring<pending | needs_review | verified | rejected | fraud | additional_information | previously_verified>DescriptionAllowedpendingneeds_reviewverifiedrejectedfraudadditional_informationpreviously_verified
- verified_atstringDescription
- updated_atstringDescription
- created_atstringDescription
- typesstring[]requiredDescription
- full_namestringDescription
- titlestringDescription
- professional_profilestringDescription
- countrystringDescription
- country_codestringDescription
- country_of_residencestringDescription
- residence_country_codestringDescription
- personal_numberstringDescription
- first_namestringDescription
- last_namestringDescription
- dobstringDescription
- emailstringDescription
- job_titlestringDescription
- apartment_numberstringDescription
- address_1stringDescription
- address_2stringDescription
- citystringDescription
- statestringDescription
- post_codestringDescription
- country_of_birthstringDescription
- birth_country_codestringDescription
- nationalitystringDescription
- person_type_detailsobjectDescription
- appointment_datestringDescription
- majoritybooleanDescription
- governingbooleanDescription
- responsibilitybooleanDescription
- majority_percentagestringDescription
- specific_ownership_percentagestringDescription
- copy_addressbooleanDescription
- updated_atstringDescription
- created_atstringDescription
- screeningsobjectDescription
- detailsobjectDescription
- providerstring<ion_group | comply_advantage | lseg_zfs>DescriptionAllowedion_groupcomply_advantagelseg_zfs
- performed_atstringDescription
- search_termstringDescription
- search_payloadobjectDescription
- is_monitoredbooleanDescription
- screeningsobject[]Description
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
400
- object
- messagestringDescription
401
- object
- messagestringDescription
422
- object
- messagestringDescription
- example_fieldstring[]Description
429
- object
- messagestringDescription
curl
curl --request POST \
--url https://api.detected.app/api/v2/public/representatives \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"name": {
"first_name": "",
"last_name": ""
},
"email": "",
"profile_id": "",
"types": []
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"name": {
"first_name": "",
"last_name": ""
},
"email": "",
"profile_id": "",
"types": []
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/representatives", 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")
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"
request.body = JSON.dump({
"name": {
"first_name": "",
"last_name": ""
},
"email": "",
"profile_id": "",
"types": []
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/representatives"
payload = json.dumps({
"name": {
"first_name": "",
"last_name": ""
},
"email": "",
"profile_id": "",
"types": []
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Created
{
"data": {
"id": "",
"profile_id": "",
"customer_reference": "",
"is_company": false,
"review_status": {
"status": "",
"verified_at": "",
"updated_at": "",
"created_at": ""
},
"types": [
""
],
"full_name": "",
"title": "",
"professional_profile": "",
"country": "",
"country_code": "",
"country_of_residence": "",
"residence_country_code": "",
"personal_number": "",
"first_name": "",
"last_name": "",
"dob": "",
"email": "",
"job_title": "",
"apartment_number": "",
"address_1": "",
"address_2": "",
"city": "",
"state": "",
"post_code": "",
"country_of_birth": "",
"birth_country_code": "",
"nationality": "",
"person_type_details": {
"appointment_date": "",
"majority": false,
"governing": false,
"responsibility": false,
"majority_percentage": "",
"specific_ownership_percentage": ""
},
"copy_address": false,
"updated_at": "",
"created_at": "",
"screenings": {
"details": {
"provider": "",
"performed_at": "",
"search_term": "",
"search_payload": {},
"is_monitored": false
},
"screenings": [
{}
]
}
}
}400
// Bad Request. The request could not be processed because it is invalid. The message field explains why.
{
"message": ""
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"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": ""
}