Docs
Aml

Create an entity

Create a new entity for monitoring purposes

POST
/v1/aml/entities

Header Parameters

x-api-keystring
entityIdstring

The identifier on you end.

schemastring

could be Person or Company

Value in"Person" | "Company"
namestring
phone?string
address?string
email?string
country?string
city?string
state?string
dob?string
monitor?boolean

Response Body

curl -X POST "https://api.ambriel.io/v1/aml/entities" \
  -H "x-api-key: string" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "string",
    "schema": "Person",
    "name": "string"
  }'
const body = JSON.stringify({
  "entityId": "string",
  "schema": "Person",
  "name": "string"
})

fetch("https://api.ambriel.io/v1/aml/entities", {
  headers: {
    "x-api-key": "string"
  },
  body
})
package main

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

func main() {
  url := "https://api.ambriel.io/v1/aml/entities"
  body := strings.NewReader(`{
    "entityId": "string",
    "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/entities"
body = {
  "entityId": "string",
  "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("""{
  "entityId": "string",
  "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/entities"))
  .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("""
{
  "entityId": "string",
  "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/entities", body);
var responseBody = await response.Content.ReadAsStringAsync();
{
  "entityId": "123",
  "schema": "Person",
  "name": "John Doe",
  "phone": "+15644045220",
  "address": "string",
  "email": "string",
  "country": "string",
  "city": "string",
  "state": "string",
  "dob": "string",
  "monitor": false,
  "lastScanAt": "2019-08-24T14:15:22Z",
  "createdAt": "2025-07-03T07:15:08.000+00:00",
  "updatedAt": "2025-07-03T07:15:08.000+00:00"
}
Empty
Empty
{
  "errors": [
    {
      "message": "The field must be a valid value",
      "rule": "ruleName",
      "field": "phone"
    }
  ]
}
Empty