Faraday REST API
Overview
Endpoints
uploads
datasets
streams
cohorts
outcomes
persona_sets
scopes
connections
targets
List targets
get
Create target
post
Delete a target
delete
Retrieve a target
get
Update a target
patch
Retrieve a target's analysis
get
Retrieve target analysis report
get
Archive a target
post
Download the default output of a target
get
Trigger a rerun for this resource.
post
Perform a lookup on the target, if its type is Lookup API.
post
Start a preview delivery
post
Unarchive a target
post
accounts
graph
billing
market_opportunity_analyses
places
recommenders
traits
usage
webhooks
Webhooks
webhooks
powered by Stoplight
Perform a lookup on the target, if its type is Lookup API.
post
https://api.faraday.ai/v1
/targets/{target_id}/lookup
Use either PII or a spatial aggregate to retrieve the payload of a Lookup API target. See the Lookup API specification's quickstart for more details, including examples.
target_id
string<uuid>The UUID of a target
A lookup request
The structure of a lookup request depends on the "mode" of the target.Show all...
identity_sets
array[object]city
stringExample:
Anytown
email
string<email>Example:
john_doe@test.com
email_hash
stringExample:
5e884898da28047151d0e56f8dc
house_number_and_street
stringExample:
123 Main Street
latitude
stringlongitude
stringperson_first_name
stringExample:
John
person_last_name
stringExample:
Doe
phone
stringpostcode
stringExample:
00001
Match pattern:
\d\d\d\d\d
search_radius
stringstate
stringExample:
Farazona or FZ
city
stringExample:
Anytown
email
string<email>Example:
john_doe@test.com
email_hash
stringExample:
5e884898da28047151d0e56f8dc
house_number_and_street
stringExample:
123 Main Street
latitude
stringlongitude
stringperson_first_name
stringExample:
John
person_last_name
stringExample:
Doe
phone
stringpostcode
stringExample:
00001
Match pattern:
\d\d\d\d\d
search_radius
stringstate
stringExample:
Farazona or FZ
Responses
200
400
401
403
404
500
The lookup response
responses
/
200
The structure of a lookup response depends on the target and the scope it is attached to.Show all...
cohabitants
array[object]An array of shared residents of the matched location which were used in aggregation.
error
stringExample:
Could not match an identity with the provided information
identity_provider
stringThe identity provider used to obtain a match with the requested identity.
Allowed values:
figmatch_boost
identity_set
objectcity
stringExample:
Anytown
email
string<email>Example:
john_doe@test.com
email_hash
stringExample:
5e884898da28047151d0e56f8dc
house_number_and_street
stringExample:
123 Main Street
latitude
stringlongitude
stringperson_first_name
stringExample:
John
person_last_name
stringExample:
Doe
phone
stringpostcode
stringExample:
00001
Match pattern:
\d\d\d\d\d
search_radius
stringstate
stringExample:
Farazona or FZ
match_type
stringThe type of match that was found for the lookup request.
Allowed values:
address_full_nameemail_full_namephone_full_nameaddress_last_nameemail_last_namephone_last_nameaddress_onlyemail_onlypostcode_onlyphone_only
city
stringExample:
Anytown
email
string<email>Example:
john_doe@test.com
email_hash
stringExample:
5e884898da28047151d0e56f8dc
house_number_and_street
stringExample:
123 Main Street
latitude
stringlongitude
stringperson_first_name
stringExample:
John
person_last_name
stringExample:
Doe
phone
stringpostcode
stringExample:
00001
Match pattern:
\d\d\d\d\d
search_radius
stringstate
stringExample:
Farazona or FZ
:
:
curl --request POST \--url https://api.faraday.ai/v1/targets/{target_id}/lookup \--header 'Accept: application/json' \--header 'Authorization: Bearer 123' \--header 'Content-Type: application/json' \--data '{"identity_sets": [{"city": "Anytown","email": "john_doe@test.com","email_hash": "5e884898da28047151d0e56f8dc","house_number_and_street": "123 Main Street","latitude": "string","longitude": "string","person_first_name": "John","person_last_name": "Doe","phone": "string","postcode": "00001","search_radius": "string","state": "Farazona or FZ"}],"city": "Anytown","email": "john_doe@test.com","email_hash": "5e884898da28047151d0e56f8dc","house_number_and_street": "123 Main Street","latitude": "string","longitude": "string","person_first_name": "John","person_last_name": "Doe","phone": "string","postcode": "00001","search_radius": "string","state": "Farazona or FZ"}'
1{2"cohabitants": [3{}4],5"error": "Could not match an identity with the provided information",6"identity_provider": "fig",7"identity_set": {8"city": "Anytown",9"email": "john_doe@test.com",10"email_hash": "5e884898da28047151d0e56f8dc",11"house_number_and_street": "123 Main Street",12"latitude": "string",13"longitude": "string",14"person_first_name": "John",15"person_last_name": "Doe",16"phone": "string",17"postcode": "00001",18"search_radius": "string",19"state": "Farazona or FZ"20},21"match_type": "address_full_name",22"city": "Anytown",23"email": "john_doe@test.com",24"email_hash": "5e884898da28047151d0e56f8dc",25"house_number_and_street": "123 Main Street",26"latitude": "string",27"longitude": "string",28"person_first_name": "John",29"person_last_name": "Doe",30"phone": "string",31"postcode": "00001",32"search_radius": "string",33"state": "Farazona or FZ"34}