Get Bulk Search

This API endpoint facilitates the retrieval of detailed information regarding specific searches within the organization. To access details of a particular search, issue a GET request to the designated endpoint, providing the unique search reference parameter. This parameter ensures precise identification of the desired search, enabling seamless retrieval of relevant data.

Endpoint: https://api.amlwatcher.com/api/bulk-searches/:batch_id

Method: GET

HTTP

Sample Request

GET /api/bulk-searches/:batch_id HTTP/1.1
Host: api.amlwatcher.com
Authorization: Bearer Token

Javascript

Sample Request

var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer Token");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow",
};

fetch("https://api.amlwatcher.com/api/bulk-searches/:batch_id", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

PHP

Sample Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.amlwatcher.com/api/bulk-searches/:batch_id',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer Token'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

Sample Request

import requests

url = "https://api.amlwatcher.com/api/bulk-searches/:batch_id"

payload = {}
headers = {
  'Authorization': 'Bearer Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Ruby

Sample Request

require "uri"
require "net/http"

url = URI("https://api.amlwatcher.com/api/bulk-searches/:batch_id")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer Token"

response = https.request(request)
puts response.read_body

Java

Sample Request

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {

  public static void main(String[] args) {
    try {
        // URL of the API endpoint
        String url = "https://api.amlwatcher.com/api/bulk-searches/:batch_id";

        // Create a URL object
        URL obj = new URL(url);

        // Open connection
        HttpURLConnection con = (HttpURLConnection) obj.openConnection();

        // Set request method to GET
        con.setRequestMethod("GET");

        // Add request header
        con.setRequestProperty("Authorization", "Bearer Token");

        // Get response code
        int responseCode = con.getResponseCode();
        System.out.println("Response Code : " + responseCode);

        // Read the response
        BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
        String inputLine;
        StringBuffer response = new StringBuffer();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        // Print the response
        System.out.println(response.toString());

    } catch (Exception e) {
        e.printStackTrace();
    }
  }
}

cURL

Sample Request

curl --location --request GET 'https://api.amlwatcher.com/api/bulk-searches/:batch_id'
--header 'Authorization: Bearer Token'

C#

Sample Request

using RestSharp; // Import RestSharp namespace
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        string batchId = "your_batch_id_here";

        var options = new RestClientOptions("https://api.amlwatcher.com")
        {
            ThrowOnAnyError = true,
            Timeout = TimeSpan.FromMilliseconds(-1)
        };
        var client = new RestClient(options);

        var requestUrl = $"/api/bulk-searches/{batchId}";

        var request = new RestRequest(requestUrl, Method.Get);
        request.AddHeader("Authorization", "Bearer Token");

        RestResponse response = await client.ExecuteAsync(request);
        Console.WriteLine(response.Content);
    }
}

Go

Sample Request

package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	url := "https://api.amlwatcher.com/api/bulk-searches/:batch_id"
	method := "GET"

	client := &http.Client{}
	req, err := http.NewRequest(method, url, nil) // No payload for GET request
	if err != nil {
		fmt.Println(err)
		return
	}

	// Set headers
	req.Header.Add("Authorization", "Bearer Token")

	// Execute the request
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

Request

Parameters	Required	Type	Description
batch_id	Yes	String	A unique batch id representing a corresponding batch.

Response

Parameters	Description
error	Whenever there is an error in your request, this param will have details of that error; otherwise it’ll remain empty.
status	The status field is set to either “SUCCESS” or “FAIL”, indicating that the API request resulted in a successful or failure/error condition respectively.
data	An object containing the actual response elements.

Sample Response

{
    "data": {
        "batch_id": "f0b8097d28c0c52b53afe1ea",
        "search_references": [
            "61ad945ebdecad0871c7835a",
            "47f81b4181b69e059de95a68"
        ]
    },
    "error": false,
    "status": "SUCCESS"
}