v3.0
Bulk Score Service API
Servers
Choose a server to use:
/api/v1.0/
https://bulkscore-qa.adara.com/api/v1.0/
https://bulkscore-prod.adara.com/api/v1.0/
json body post request to get the matches
POST /match
Auth
Request Body
| object | object | required | |
| input | object | required | |
| bucket | string | required | |
| files | array[string] | required | |
| id_type | string | required | |
| hash_type | string | required |
Example Request
x
curl --request POST \ --url /api/v1.0//match \ --data '{ "input": { "bucket": "dot-sandbox-test", "files": [ "test/ids.csv" ], "id_type": "email", "hash_type": "sha256" }}'Responses
200 400 401
| object | object | ||
| active | boolean | Feature a flag that the feature endpoint is interactive | optional |
| response | object | optional | |
| created | integer | Unix Timestamp | optional |
| job_id | string | unique id for the request | optional |
Example Response
200 Successfully returned the match details
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
xxxxxxxxxx{ "active": "{boolean}", "response": { "created": "{integer}", "job_id": "{string}" }}Sample json body post request that creates and triggers a bulk request task
POST /score
Auth
Request Body
| object | object | ||
| input | object | optional | |
| bucket | string | required | |
| files | array[string] | required | |
| id_type | string | required | |
| hash_type | string | required | |
| query | object | optional | |
| signals | array[string] | required | |
| limit | integer | optional | |
| include_all | boolean | required | |
| delimiter | string | required |
Example Request
xxxxxxxxxxcurl --request POST \ --url /api/v1.0//score \ --data '{ "input": { "bucket": "dot-sandbox-test", "files": [ "test/ids.csv" ], "id_type": "email", "hash_type": "sha256" }, "query": { "signals": [ "UUS_TVS_1", "UUC_BL_1", "UUC_VPN_1" ], "limit": "{integer}", "include_all": true, "delimiter": "," }}'Responses
200 400 401
| object | object | ||
| active | boolean | feature flag indicating that the feature endpoint is interactive | optional |
| response | object | optional | |
| created | integer | unix timestamp of file upload time in seconds | optional |
| job_id | string | unique id for the request | optional |
Example Response
200 Successfully returned list of intel scores
400 Invalid request format
401 Missing/Invalid/Expired Authorization Token
xxxxxxxxxx{ "active": "{boolean}", "response": { "created": "{integer}", "job_id": "{string}" }}