Aml
Screen an entity
look for an entity in sanctions, crime, pep, watchlists.
Header Parameters
x-api-keystring
schemastring
could be Person or Company
Value in
"Person" | "Company"
namestring
country?string
nationality for natural person, Alpha2 country code
dob?string
YYYY-MM-DD format
Response Body
curl -X POST "https://api.ambriel.io/v1/aml/screen" \
-H "x-api-key: string" \
-H "Content-Type: application/json" \
-d '{
"schema": "Person",
"name": "string"
}'
const body = JSON.stringify({
"schema": "Person",
"name": "string"
})
fetch("https://api.ambriel.io/v1/aml/screen", {
headers: {
"x-api-key": "string"
},
body
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "https://api.ambriel.io/v1/aml/screen"
body := strings.NewReader(`{
"schema": "Person",
"name": "string"
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("x-api-key", "string")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
import requests
url = "https://api.ambriel.io/v1/aml/screen"
body = {
"schema": "Person",
"name": "string"
}
response = requests.request("POST", url, json = body, headers = {
"x-api-key": "string",
"Content-Type": "application/json"
})
print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;
var body = BodyPublishers.ofString("""{
"schema": "Person",
"name": "string"
}""");
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
.uri(URI.create("https://api.ambriel.io/v1/aml/screen"))
.header("x-api-key", "string")
.header("Content-Type", "application/json")
.POST(body)
.build();
try {
HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
System.out.println("Status code: " + response.statusCode());
System.out.println("Response body: " + response.body());
} catch (Exception e) {
e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;
var body = new StringContent("""
{
"schema": "Person",
"name": "string"
}
""", Encoding.UTF8, "application/json");
var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "string");
var response = await client.PostAsync("https://api.ambriel.io/v1/aml/screen", body);
var responseBody = await response.Content.ReadAsStringAsync();
{
"found": 1,
"hits": [
{
"document": {
"schema": "Person",
"name": "string",
"phone": "string",
"address": "string",
"email": "string",
"country": "string",
"city": "string",
"state": "string",
"dob": "string"
},
"highlight": {
"name": {
"matched_tokens": [
"string"
],
"snippet": "string"
}
},
"highlights": [
{
"field": "string",
"matched_tokens": [
"string"
],
"snippet": "string"
}
],
"text_match": 0,
"text_match_info": {
"best_field_score": "string",
"best_field_weight": 0,
"fields_matched": 0,
"score": "string",
"tokens_matched": 0
},
"confidence": 0
}
],
"out_of": 0,
"page": 0,
"request_params": {
"collection_name": "string",
"per_page": 0,
"q": "string"
},
"search_cutoff": true,
"search_time_ms": 0
}
Empty
Empty
Empty
{
"errors": [
{
"message": "The field must be a valid value",
"rule": "ruleName",
"field": "phone"
}
]
}
Empty