GET /entities/{id}

Get entity

Bearer API key or staff session operation getEntity

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	—

Request

This endpoint has no request body.

curl "$MONICHEK_API/entities/{id}" \
  -H "Authorization: Bearer $MONICHEK_API_KEY"

const res = await fetch(`${MONICHEK_API}/entities/{id}`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
  },
});

const data = await res.json();

import os
import requests

res = requests.get(
    f"{os.environ['MONICHEK_API']}/entities/{id}",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/entities/{id}');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Replace {id} with the resource id.

Responses

200 OK entity application/json

{
  "id": "ofac-5678",
  "schema": "Person",
  "dataset": "us_ofac_sdn",
  "topics": [
    "sanction"
  ],
  "programs": [
    "LIBYA3"
  ],
  "names": [
    "Viktor Anatolyevich Bout"
  ]
}

Error responses

Status	Meaning	Body
401	Unauthorized	RFC 9457 problem
404	Not Found	RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.