curl --request PUT \
--url https://api.baselayer.com/portfolio/monitoring_policy \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cadence": "daily",
"enabled": true,
"attributes": [
"liens",
"litigations"
],
"lien_monitoring_scope": "domestic"
}
'import requests
url = "https://api.baselayer.com/portfolio/monitoring_policy"
payload = {
"cadence": "daily",
"enabled": True,
"attributes": ["liens", "litigations"],
"lien_monitoring_scope": "domestic"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cadence: 'daily',
enabled: true,
attributes: ['liens', 'litigations'],
lien_monitoring_scope: 'domestic'
})
};
fetch('https://api.baselayer.com/portfolio/monitoring_policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.baselayer.com/portfolio/monitoring_policy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cadence' => 'daily',
'enabled' => true,
'attributes' => [
'liens',
'litigations'
],
'lien_monitoring_scope' => 'domestic'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/portfolio/monitoring_policy"
payload := strings.NewReader("{\n \"cadence\": \"daily\",\n \"enabled\": true,\n \"attributes\": [\n \"liens\",\n \"litigations\"\n ],\n \"lien_monitoring_scope\": \"domestic\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.baselayer.com/portfolio/monitoring_policy")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cadence\": \"daily\",\n \"enabled\": true,\n \"attributes\": [\n \"liens\",\n \"litigations\"\n ],\n \"lien_monitoring_scope\": \"domestic\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/portfolio/monitoring_policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cadence\": \"daily\",\n \"enabled\": true,\n \"attributes\": [\n \"liens\",\n \"litigations\"\n ],\n \"lien_monitoring_scope\": \"domestic\"\n}"
response = http.request(request)
puts response.read_body{
"cadence": "daily",
"lien_monitoring_scope": "domestic",
"enabled": true,
"attributes": [],
"last_run_at": "2023-11-07T05:31:56Z",
"next_run_on": "2023-12-25",
"inherited_from": "portfolio"
}Update Portfolio Monitoring Policy
Update the monitoring policy for the portfolio.
curl --request PUT \
--url https://api.baselayer.com/portfolio/monitoring_policy \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cadence": "daily",
"enabled": true,
"attributes": [
"liens",
"litigations"
],
"lien_monitoring_scope": "domestic"
}
'import requests
url = "https://api.baselayer.com/portfolio/monitoring_policy"
payload = {
"cadence": "daily",
"enabled": True,
"attributes": ["liens", "litigations"],
"lien_monitoring_scope": "domestic"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cadence: 'daily',
enabled: true,
attributes: ['liens', 'litigations'],
lien_monitoring_scope: 'domestic'
})
};
fetch('https://api.baselayer.com/portfolio/monitoring_policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.baselayer.com/portfolio/monitoring_policy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cadence' => 'daily',
'enabled' => true,
'attributes' => [
'liens',
'litigations'
],
'lien_monitoring_scope' => 'domestic'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/portfolio/monitoring_policy"
payload := strings.NewReader("{\n \"cadence\": \"daily\",\n \"enabled\": true,\n \"attributes\": [\n \"liens\",\n \"litigations\"\n ],\n \"lien_monitoring_scope\": \"domestic\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.baselayer.com/portfolio/monitoring_policy")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cadence\": \"daily\",\n \"enabled\": true,\n \"attributes\": [\n \"liens\",\n \"litigations\"\n ],\n \"lien_monitoring_scope\": \"domestic\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/portfolio/monitoring_policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cadence\": \"daily\",\n \"enabled\": true,\n \"attributes\": [\n \"liens\",\n \"litigations\"\n ],\n \"lien_monitoring_scope\": \"domestic\"\n}"
response = http.request(request)
puts response.read_body{
"cadence": "daily",
"lien_monitoring_scope": "domestic",
"enabled": true,
"attributes": [],
"last_run_at": "2023-11-07T05:31:56Z",
"next_run_on": "2023-12-25",
"inherited_from": "portfolio"
}Authorizations
Body
Request model for creating or updating a monitoring policy.
The monitoring cadence (daily, weekly, monthly, yearly).
daily, weekly, biweekly, monthly, quarterly, biannually, annually "daily"
"weekly"
"monthly"
"yearly"
Whether the monitoring policy should be enabled.
List of attributes to monitor (liens, litigations, bankruptcies, etc.).
The attributes that can be monitored.
sos, liens, litigations, bankruptcies, website_analysis, pep, ofac, identity_network ["liens", "litigations"]
["website_analysis", "ofac"]
The scope of lien monitoring (domestic or registered).
domestic, registered "domestic"
"registered"
Response
Response
Represents a monitoring policy response.
This representation is designed for use in the singleton resource API representations.
Note that id, group_id, and item_id are not included in this representation.
This is to avoid confusion when API resource inheritance is in effect.
The monitoring cadence (e.g., 'daily', 'weekly', 'monthly').
daily, weekly, biweekly, monthly, quarterly, biannually, annually The scope of lien monitoring.
domestic, registered Whether the monitoring policy is enabled.
The attributes to monitor.
The attributes that can be monitored.
sos, liens, litigations, bankruptcies, website_analysis, pep, ofac, identity_network When the notification policy was last executed.
When the notification policy is scheduled to run next.
Indicates where this policy was inherited from (e.g., 'portfolio', 'group', or None for direct).
portfolio, group