ID Translation Service 1.0.0

Server

/api/v1.0/

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

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

Authentication

oauth2 oauth2

FlowClient Credentials

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

Add new ID links

Add ID links to the ID graph

Auth

Required Scopes:post:links

Request Body

array	array[object]
provider_id	string
ids3 fields	array[object]
id	string
id_type	string
hash_type	string

POST /links

curl --request POST \

--url '/api/v1.0//links' \

--header 'Authorization: Bearer {token}' \

--data '[

{

"provider_id": "{string}",

"ids": [

{

"id": "{string}",

"id_type": "email",

"hash_type": "sha256"

}

]

}

]'

Copy

Responses

201

Successfully added links

No response body

Response

No response

Copy

Translate ids in a file

Generate a mapping file of Input to output IDs

Auth

Required Scopes:post:batch

Request Body

object	object
input4 fields	object
bucket	string
files	array[string]
id_type	string
hash_type	string
output	object
id_type	string
hash_type	string
filter	object
max_centrality	integer	Maximum number of edges to be considered a valid vertex maximum: 100 minimum: 1 Default: 20
max_steps	integer	Maximum number of edges to traverse from origin id maximum: 10 minimum: 1 Default: 2

POST /batch

curl --request POST \

--url '/api/v1.0//batch' \

--header 'Authorization: Bearer {token}' \

--data '{

"input": {

"bucket": "dot-sandbox-test",

"files": [

"endpointowner_id/client_id/emails_dec_2018.csv",

"endpointowner_id/client_id/emails_jan_2019.csv"

],

"id_type": "email",

"hash_type": "sha256"

},

"output": {

"id_type": "email",

"hash_type": "sha256"

},

"filter": {

"max_centrality": 20,

"max_steps": 2

}

}'

Copy

Responses

200

Successfully Created a batch translation job

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

Response

{

"active": "{boolean}",

"response": {

"created": "{integer}",

"job_id": "{string}"

}

}

Copy

Translate an ID

Auth

Required Scopes:post:translation

Request Body

object	object
input3 fields	object
id	string
id_type	string
hash_type	string
output	object
id_type	string
hash_type	string
filter	object
max_centrality	integer	Maximum number of edges to be considered a valid vertex maximum: 100 minimum: 1 Default: 20
max_steps	integer	Maximum number of edges to traverse from origin id maximum: 10 minimum: 1 Default: 2

POST /translation

curl --request POST \

--url '/api/v1.0//translation' \

--header 'Authorization: Bearer {token}' \

--data '{

"input": {

"id": "8cd869636bd9448ef3eef342da47157a8f4fc630e5c227d67906efcc0fd3f163",

"id_type": "email",

"hash_type": "sha256"

},

"output": {

"id_type": "email",

"hash_type": "sha256"

},

"filter": {

"max_centrality": 20,

"max_steps": 2

}

}'

Copy

Responses

200

Successfully returned list of intel scores

object	object
active	boolean	feature flag indicating that the feature endpoint is interactive
response	array[string]

Response

{

"active": "{boolean}",

"response": [

"342432119"

]

}

Copy