Create a profile
1 min
POST
https://api.detected.app/api/v2/public/profiles
Body Parameters
- bodyCreateProfileRequestDescription
- objectCreateProfileFromSearchRequest
- typestring<company | sole_trader | partnership | charity | government_entity | incorporated_syndicate | company_syndicate | syndicate | association | trust | fund | club | individual | joint_individual>DescriptionAllowedcompanysole_traderpartnershipcharitygovernment_entityincorporated_syndicatecompany_syndicatesyndicateassociationtrustfundclubindividualjoint_individual
- lookup_idnumberrequiredDescription
- response_idnumberrequiredDescription
- customer_referencestringrequiredDescription
- brand_idstring<uuid>DescriptionFormatuuid
- domainstringDescription
- objectCreateProfileManualRequest
- typestring<company | sole_trader | partnership | charity | government_entity | incorporated_syndicate | company_syndicate | syndicate | association | trust | fund | club | individual | joint_individual>DescriptionAllowedcompanysole_traderpartnershipcharitygovernment_entityincorporated_syndicatecompany_syndicatesyndicateassociationtrustfundclubindividualjoint_individual
- customer_referencestringrequiredDescription
- brand_idstring<uuid>DescriptionFormatuuid
- company_numberstringDescription
- namestringrequiredDescription
- vat_numberstringDescription
- domainstringDescription
- addressobjectrequiredDescription
- line_1stringDescription
- line_2stringDescription
- country_codestringrequiredDescription
- townstringDescription
- citystringrequiredDescription
- post_codestringDescription
- provincestringDescription
- statestringDescription
Responses
201
- object
- dataProfileListResource
- idstringrequiredDescription
- entity_typeobjectDescription
- idintegerDescription
- typestring<company | sole_trader | partnership | charity | government_entity | incorporated_syndicate | company_syndicate | syndicate | association | trust | fund | club | individual | joint_individual>DescriptionAllowedcompanysole_traderpartnershipcharitygovernment_entityincorporated_syndicatecompany_syndicatesyndicateassociationtrustfundclubindividualjoint_individual
- labelstringDescription
- customer_referencestringrequiredDescription
- company_namestringDescription
- riskobjectDescription
- idstringDescription
- labelstringDescription
- categorystringDescription
- teamobjectDescription
- idnumberDescription
- labelstringDescription
- configurationobjectDescription
- idnumberDescription
- namestringDescription
- brandobjectDescription
- idstringDescription
- namestringDescription
- slugstringDescription
- review_statusstring<Processed | Needs Review | Additional Info Required | Approved | Declined | Archived>requiredDescriptionAllowedProcessedNeeds ReviewAdditional Info RequiredApprovedDeclinedArchived
- assigneeobjectDescription
- idstringDescription
- namestringDescription
- review_atstringDescription
- updated_atstringrequiredDescription
- created_atstringrequiredDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
- x-ratelimit-reset
- retry-after
401
- object
- messagestringDescription
422
- object
- messagestringDescription
- example_fieldstring[]Description
429
- object
- messagestringDescription
curl
curl --request POST \
--url https://api.detected.app/api/v2/public/profiles \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"lookup_id": "",
"response_id": "",
"customer_reference": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"lookup_id": "",
"response_id": "",
"customer_reference": ""
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/profiles", 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/profiles")
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({
"lookup_id": "",
"response_id": "",
"customer_reference": ""
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/profiles"
payload = json.dumps({
"lookup_id": "",
"response_id": "",
"customer_reference": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Created. The profile was created.
{
"data": {
"id": "",
"entity_type": {
"id": 0,
"type": "",
"label": ""
},
"customer_reference": "",
"company_name": "",
"risk": {
"id": "",
"label": "",
"category": ""
},
"team": {
"id": 0,
"label": ""
},
"configuration": {
"id": 0,
"name": ""
},
"brand": {
"id": "",
"name": "",
"slug": ""
},
"review_status": "",
"assignee": {
"id": "",
"name": ""
},
"review_at": "",
"updated_at": "",
"created_at": ""
}
}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": ""
}