REST API

Rest API for custom integrations

How to use the Rest API

1) Register new users to our daily monitoring

Call the Rest API endpoint '/v1/register_users' with all your users (email's) to start the catching all the public breaches on the dark web.

2) Remove a user, from our daily monitoring

Call the Rest API endpoint '/v1/delete_users' with all your users (email's) to stop the monitoring of all the public breaches on the dark web.

Register new users

Register new users

POST https://api.andia.io/v1/register_users

Register users (emails) in our monitoring service.

Headers

Name
Type
Description

APIKEY

string

******* Your customer APIKEY

Request Body

Name
Type
Description

object

{ "emails": [ {"user_email":"user01@gmail.com"}, {"user_email":"user02@company.com"} ] } 

{
    "success": true,
    "error_code": 200,
    "error": null,
    "message": "Success"
}

Example:

curl --location --request POST 'https://api.andia.io/v1/register_users' \
--header 'APIKEY: XXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "emails": [
        {
            "user_email": "user01@gmail.com"
        },
        {
            "user_email": "user02@company.com"
        }
    ]
}'

Delete users

POST https://api.andia.io/v1/delete_users

Remove users from our monitoring service.

Headers

Name
Type
Description

APIKEY

string

******* Your customer APIKEY

Request Body

Name
Type
Description

object

{ "emails": [ {"user_email":"user01@gmail.com"}, {"user_email":"user02@company.com"} ] } 

{
    "success": true,
    "error_code": 200,
    "error": null,
    "message": "Success"
}

Example:

curl --location --request POST 'https://api.andia.io/v1/delete_users' \
--header 'APIKEY: XXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "emails": [
        {
            "user_email": "user01@gmail.com"
        },
        {
            "user_email": "user02@company.com"
        }
    ]
}'

Last updated

Was this helpful?