Bulk Score Service API 1.0.0

Server

/api/v1.0/

https://bulkscore-qa.adara.com/api/v1.0/

https://bulkscore-prod.adara.com/api/v1.0/

Authentication

oauth2 oauth2

FlowClient Credentials

Token URL/core/v1.0/oauth/token

json body post request to get the matches

Auth

Required Scopes:post:match

Request Body

object	object
input	object
bucket	string
files	array[string]
id_type	string
hash_type	string

POST /match

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//match' \ --header 'Authorization: Bearer {token}' \ --data '{  "input": {    "bucket": "dot-sandbox-test",    "files": [      "test/ids.csv"    ],    "id_type": "email",    "hash_type": "sha256"  }}'
Copy

Responses

200

Successfully returned the match details

object	object
active	boolean	Feature a flag that the feature endpoint is interactive
response	object
created	integer	Unix Timestamp
job_id	string	unique id for the request

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "job_id": "{string}" }}
Copy

Sample json body post request that creates and triggers a bulk request task

Auth

Required Scopes:post:score

Request Body

object	object
input	object
bucket	string
files	array[string]
id_type	string
hash_type	string
query	object
signals	array[string]
limit	integer
include_all	boolean
delimiter	string

POST /score

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//score' \ --header 'Authorization: Bearer {token}' \ --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": ","  }}'
Copy

Responses

200

Successfully returned list of intel scores

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive
response	object
created	integer	unix timestamp of file upload time in seconds
job_id	string	unique id for the request

400

Invalid request format

401

Missing/Invalid/Expired Authorization Token

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": {  "created": "{integer}",  "job_id": "{string}" }}
Copy