v3.0
ID Translation Service
Servers
Choose a server to use:
/api/v1.0/
https://id-qa.adara.com/api/v1.0/
https://id-prod.adara.com/api/v1.0/
Add new ID links
POST /links
Add ID links to the ID graph
Auth
Request Body
| array | array[object] | ||
| provider_id | string | optional | |
| ids | array[object] | optional | |
| id | string | required | |
| id_type | string | required | |
| hash_type | string | optional |
Example Request
x
curl --request POST \ --url /api/v1.0//links \ --data '[ { "provider_id": "{string}", "ids": [ { "id": "{string}", "id_type": "email", "hash_type": "sha256" } ] }]'Responses
201
| No response body |
Example Response
201 Successfully added links
xxxxxxxxxxNo responseTranslate ids in a file
POST /batch
Generate a mapping file of Input to output IDs
Auth
Request Body
| object | object | ||
| input | object | optional | |
| bucket | string | required | |
| files | array[string] | required | |
| id_type | string | required | |
| hash_type | string | required | |
| output | object | optional | |
| id_type | string | required | |
| hash_type | string | optional | |
| filter | object | optional | |
| max_centrality | integer | Maximum number of edges to be considered a valid vertex maximum: 100 minimum: 1 Default: 20 | required |
| max_steps | integer | Maximum number of edges to traverse from origin id maximum: 10 minimum: 1 Default: 2 | required |
Example Request
xxxxxxxxxxcurl --request POST \ --url /api/v1.0//batch \ --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 }}'Responses
200
| 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 Created a batch translation job
xxxxxxxxxx{ "active": "{boolean}", "response": { "created": "{integer}", "job_id": "{string}" }}Translate an ID
POST /translation
Auth
Request Body
| object | object | required | |
| input | object | required | |
| id | string | required | |
| id_type | string | required | |
| hash_type | string | optional | |
| output | object | required | |
| id_type | string | required | |
| hash_type | string | optional | |
| filter | object | required | |
| max_centrality | integer | Maximum number of edges to be considered a valid vertex maximum: 100 minimum: 1 Default: 20 | required |
| max_steps | integer | Maximum number of edges to traverse from origin id maximum: 10 minimum: 1 Default: 2 | required |
Example Request
xxxxxxxxxxcurl --request POST \ --url /api/v1.0//translation \ --data '{ "input": { "id": "8cd869636bd9448ef3eef342da47157a8f4fc630e5c227d67906efcc0fd3f163", "id_type": "email", "hash_type": "sha256" }, "output": { "id_type": "email", "hash_type": "sha256" }, "filter": { "max_centrality": 20, "max_steps": 2 }}'Responses
200
| object | object | ||
| active | boolean | feature flag indicating that the feature endpoint is interactive | optional |
| response | array[string] | optional |
Example Response
200 Successfully returned list of intel scores
xxxxxxxxxx{ "active": "{boolean}", "response": [ "342432119" ]}