Licensed API
VerifyNow™ AML
Enrol an identified person or company, run the first screen, then rescreen against refreshed lists on your RMCP cadence. Withdraw when the relationship ends. Enrolment is API-first.
This is the licensed ongoing AML and ODD API. One-shot AML/PEP screening stays on POST /aml-screening. Product overview: VerifyNow™ AML.
Licensed path
POST /api/external/aml-ongoingAuthentication
Send an API key from your licensed account in x-api-key.
Credits
First enrol uses AML/PEP credits. Same-subject rescreens on an active licence use 0 credits within the contracted population and request limit.
Standard retail prices include VAT. Annual licence fees are separate.
Access
Annual licence for individuals and teams. Production uses your account API key. Ongoing rescreens need an active licence.
Buy an annual licenceAuthentication
Production calls use your account API key, which is hashed at rest and tied to your VerifyNow™ AML licence. Paying for the annual licence activates ongoing AML access. Send the key in x-api-key. Production requests also send a unique Idempotency-Key between 8 and 160 characters. Reuse that key only when retrying the same body.
A result with Found: false means the screen found no matches in the dataset used. Source coverage can vary. Review the coverage details in Ongoing AML settings before relying on a result.
Set mode to sandbox for mock results. Sandbox calls use 0 credits. Production ongoing rescreens require an active licence.
Screening data and safeguards
Processing and transfer safeguards are set out in the Data Processing Agreement. Some infrastructure services process information outside South Africa under the applicable safeguards. See the infrastructure register for provider roles.
Screening and review responsibilities
VerifyNow supplies screening results and source evidence for your team's review. Source-change notices prompt client-initiated rescreens. Transaction monitoring and EDD case management remain customer-managed activities, including decisions about source of funds and any required approval.
Refine person matches with a date of birth
Set refineWithDob: true on an ongoing or standard AML screening request. Supply dateOfBirth as YYYY-MM-DD; ongoing requests can also use properties.birthDate. For an ongoing request with identifierType: "sa_id", the birth date comes from the validated ID. Standard requests use idNumber with country: "za". An explicit DOB resolves the ID’s two-digit birth year and must agree with its encoded date.
Refinement lowers scores when known DOB components disagree. Sources without a usable DOB remain candidates, and exact identifier matches remain available for review when dates conflict. Review potential matches before deciding whether they refer to your customer. Depending on your account, refinement may be on by default when a date of birth or SA ID is sent. Send refineWithDob: true or false to choose explicitly. Sandbox responses remain sample data.
Batch uploads support optional SA ID Number and Date of Birth columns. Store both as text, retain leading zeros, and select “Use ID and date of birth to refine matches” before submitting. Each completed row uses the existing screening price.
Reading match explanations
ConfidenceScore and score use the same 0–1 evidence scale: an exact name alone scores 0.50; an exact name with a matching full DOB scores 1.00; an exact name with a matching identifier can reach 1.00. A matching partial birth date contributes 0.10. Contradictory birth dates or numbers in names reduce the score. Country and address signals support candidate selection. The maximum score describes evidence agreement and requires identity review. Candidate retrieval still uses its existing threshold, shown in SearchResults.InputMinScore, so a returned match can have ConfidenceScore below 0.90. MatchExplanations contains the contributing signals; FieldEvidence identifies their sources. Existing response fields and request parameters are unchanged. Previously saved or idempotently replayed responses retain their recorded scores. This applies to /aml-screening and /aml-ongoing.
| Key | Effect on score | Meaning |
|---|---|---|
name_match | Up to 0.50 | Best similarity between the submitted name and the listed name or its aliases. Every match has it. |
identifier_match | +0.50 | An ID, passport, registration, LEI or tax number matches after format normalization. Together with an exact name match this reaches the maximum score, subject to contradictory evidence. |
birth_date_match | +0.50 | The date of birth you sent (or the one taken from an SA ID) matches a listed date. |
birth_date_partial_match | +0.10 | With refineWithDob, the known parts of the date agree but the listed date is less precise. |
birth_date_mismatch | −0.20 | With refineWithDob, the known parts of the date disagree. An exact identifier match is still returned for review. |
birth_year_match | +0.10 | Without refinement, the birth year agrees but the full date differs in precision. |
birth_year_mismatch | −0.20 | Without refinement, the supplied and listed birth years differ. |
country_match | Candidate selection only | The country you sent agrees with the listed country. |
country_mismatch | Candidate selection only | The country you sent differs from the listed country. |
address_match | Candidate selection only | An address you sent is similar to a listed address. |
name_number_mismatch | −0.15 | Numbers in the submitted and listed names differ, for example vessel or company numbers. |
"ConfidenceScore": 1.00,
"MatchExplanations": {
"name_match": { "score": 1, "weight": 0.5, "impact": 0.5,
"query": "atul gupta", "candidate": "atul gupta",
"detail": "Best comparison across the submitted name and source aliases." },
"birth_date_match": { "score": 1, "weight": 0.5, "impact": 0.5,
"query": "1968-06-14", "candidate": "14 Jun 1968",
"detail": "A supplied or ID-derived date of birth matches a source value." },
"country_mismatch": { "score": 1, "weight": 0, "impact": 0,
"query": "south africa", "candidate": "united arab emirates",
"detail": "The supplied and listed countries differ. This signal supports candidate selection." }
}Enrol and rescreen
POST the customer name plus identifier. The first call enrols the subject and runs the onboarding screen. The same payload rescreens that enrolled subject. Read operation in the response: onboarding for the first enrol, ongoing for a same-subject rescreen on an active licence.
If an official identifier is unknown, use identifierType: "customer_reference" with any unique numeric identifier in identifierValue, sent as a string of 1 to 64 digits. Keep this reference unique within your organisation and reuse it on rescreens and withdrawal. It tracks enrolment; screening uses the name and any supplied screening properties. Omit identifierCountry for customer references. A changed name can trigger a paid alias onboarding screen.
{"name":"Jane Doe","entity":0,"country":"za","dataset":"all","mode":"production","identifierType":"customer_reference","identifierValue":"100001"}| Field | Value |
|---|---|
| name | Person or company name, 2 to 300 characters |
| identifierType | sa_id or passport for a person; cipc, lei, or tax for a company |
| identifierValue | The ID, passport, CIPC, LEI, or tax number |
| entity | 0 Person, 1 Company, 2 Organization, 3 LegalEntity |
| country | Two-letter ISO country code |
| dataset | all, sanctions, peps, or crime |
| mode | sandbox or production |
| identifierCountry | Optional two-letter ISO code. sa_id, cipc, and tax default to ZA |
One VerifyNow™ AML licence includes sanctions, PEP, RCA, crime, wanted, regulatory and debarment screening. Use dataset: "peps" for PEP and RCA screening or dataset: "all" for all supported categories.
Person enrol
curl -X POST https://www.verifynow.co.za/api/external/aml-ongoing \
-H "x-api-key: $VERIFYNOW_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"mode": "production",
"name": "SAMPLE MATCH PERSON",
"entity": 0,
"country": "za",
"dataset": "all",
"identifierType": "sa_id",
"identifierValue": "8001015009087"
}'Company enrol
curl -X POST https://www.verifynow.co.za/api/external/aml-ongoing \
-H "x-api-key: $VERIFYNOW_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"mode": "production",
"name": "SAMPLE MATCH COMPANY",
"entity": 1,
"country": "za",
"dataset": "all",
"identifierType": "cipc",
"identifierValue": "202012345607"
}'Production path is POST /api/external/aml-ongoing. Access requires your licensed account API key. Ongoing rescreens also need an active licence.
Identifiers
Ongoing CDD attaches later screens to the same identified customer. Send the name and identifier on every rescreen.
International enrollment
Use passport or national_id for a person, and company_registration or lei for an organisation outside South Africa. Send identifierCountry explicitly and keep the same type, country and identifier on every rescreen. For passports and national IDs use the issuing country; for company registrations use the registry jurisdiction.
The new national_id and company_registration formats accept 2–64 letters, digits, spaces, dots, slashes or hyphens. Input is normalized with NFKC, uppercase and outer whitespace trimming; internal separators remain significant. These are enrollment keys with format checks. Issuer verification is a separate check.
sa_id, cipc and tax retain their South African validation rules. An active licence is required for ongoing rescreens; sandbox requests do not create enrollments.
| Field | Value |
|---|---|
| Person or company · customer_reference | Unique numeric customer reference, 1–64 digits sent as a string. Omit identifierCountry. Reuse the reference for rescreens and withdrawal. |
| Person · national_id | International national identifier. Send identifierCountry explicitly; 2–64 permitted characters. |
| Company · company_registration | International registry number. Send the registry country explicitly; 2–64 permitted characters. |
| Person · sa_id | South African ID number. Format, date, citizenship, and checksum are checked. |
| Person · passport | 5 to 20 letters or digits. Send identifierCountry. |
| Company · cipc | CIPC registration number, 8 to 14 digits. |
| Company · lei | 20 alphanumeric characters. |
| Company · tax | 9 or 10 digits. South African tax numbers default to ZA. |
Using ongoing AML in your own platform
This reseller integration guidance applies only to /aml-ongoing, its withdrawal endpoint and its dataset-update webhook workflow. You can serve multiple clients through one VerifyNow organisation. All subjects enrolled through that organisation share its monitored population allowance, licence limits and credit balance. VerifyNow bills your organisation. Your platform manages client access and customer billing.
Assign a reference to each client’s subject
Keep a client ID in your application and assign a permanent customer reference to each subject enrolled for that client. Store the mapping in your database. References must be unique across your entire VerifyNow organisation, including all clients and entity types. Enrolment lookup uses the reference within your organisation. Two people with the same name remain separate when their references differ.
| Field | Value |
|---|---|
| Client A · Jane Smith, first person | 100001 |
| Client A · Jane Smith, second person | 100002 |
| Client B · Jane Smith | 100003 |
Send identifierType: "customer_reference" and an identifierValue containing 1–64 digits as a JSON string. Omit identifierCountry. Reuse the stored reference for rescreens and withdrawal. Screening uses the supplied name and screening properties; separate enrolments can return similar matches.
{"name":"Jane Smith","entity":0,"country":"za","dataset":"sanctions","mode":"production","identifierType":"customer_reference","identifierValue":"100001"}Handle reference and request edge cases
- Allocate references through a database-generated numeric ID with a uniqueness constraint across your organisation’s reference registry. Allocation must handle concurrent requests. Map client-local subject IDs to this reference; concatenating client and subject IDs can create collisions.
- Keep references as strings throughout your application. Preserve leading zeros and avoid numeric conversions that lose precision. Allocate and save the reference before the first API request.
- Reusing a reference associates the request with the existing enrolment, even if the submitted name changes. VerifyNow receives your shared organisation context, so your application must check client ownership before using a reference or returning results.
- Keep the reference when the same subject’s name changes. A changed name can trigger paid alias onboarding. Reserve retired references for their original client and subject; enrolling a withdrawn subject again follows existing onboarding rules.
- When two clients monitor the same person, assign each client’s enrolment its own reference. Each enrolment counts towards your population and follows existing onboarding charges. Withdrawal affects the enrolment identified by the supplied reference.
- Generate idempotency keys across the shared organisation. Reuse the same key and payload when retrying the same operation. Each new operation, including a later rescreen or withdrawal, needs a new key.
Run monitoring through your backend
Hold the VerifyNow API key on your server and associate each response with the originating client and subject. Your platform controls access to results and produces client-level reports. Receive dataset-update webhooks, then queue rescreens for enrolled subjects on your review cadence. Same-subject rescreens use zero credits while the required licence is active, subject to its limits.
Responses
Customer responses keep match evidence. Read results.Success, results.SearchResults.Found, and RecordCount. Sample JSON uses synthetic names and matches the product page.
Request
{
"mode": "production",
"name": "SAMPLE MATCH PERSON",
"entity": 0,
"country": "za",
"dataset": "all",
"identifierType": "sa_id",
"identifierValue": "8001015009087"
}Positive match · operation onboarding
{
"success": true,
"requestId": "enrol-sample-match-01",
"results": {
"Success": true,
"ResponseCode": 200,
"Messages": [
"Possible financial-crime matches found"
],
"Header": {
"SearchDate": "2026-08-17T08:00:00.000Z",
"ReportName": "SAMPLE MATCH PERSON",
"ReportReference": "amlmon_enrolsamplematch0100000000000000",
"ClientReference": "enrol-sample-match-01",
"ReportType": "Ongoing Financial Crime Monitoring",
"AuditReference": "amlmon_enrolsamplematch0100000000000000",
"DatasetVersion": "aml_20260817_sample",
"DatasetPublishedAt": "2026-08-17T07:12:00.000Z",
"ScreenedAt": "2026-08-17T08:00:00.000Z",
"CategoriesRequested": [
"sanctions",
"crime",
"wanted",
"regulatory",
"debarment",
"pep",
"rca"
],
"DataOrigin": "publisher_direct"
},
"SearchResults": {
"InputName": "SAMPLE MATCH PERSON",
"InputMinScore": "90",
"InputIdentifierMatchBoostingThreshold": "",
"InputCountry": "ZA",
"Found": true,
"Message": "Possible financial-crime matches found",
"RecordCount": 1,
"EntityMatchCount": 1,
"JurisdictionRiskCount": 0,
"HasNextPage": false
},
"PossibleMatches": {
"Found": true,
"Message": "Possible financial-crime matches found",
"HasNextPage": false,
"Results": [
{
"Name": "SAMPLE MATCH PERSON",
"AltNames": [
"SAMPLE MATCH ALIAS"
],
"EntityId": "vn-a1b2c3d4e5f6789012345678",
"EntityType": "Person",
"CountryResidence": [
"ZA"
],
"DateOfBirth": [
"1980-01-01"
],
"Identifiers": [],
"Address": [],
"ConfidenceScore": 0.5,
"RiskCategories": [
"sanctions"
],
"Topics": [
"sanction"
],
"MatchExplanations": {
"name_match": {
"score": 1,
"weight": 0.5,
"impact": 0.5,
"query": "SAMPLE MATCH PERSON",
"candidate": "SAMPLE MATCH PERSON",
"detail": "Best comparison across the submitted name and source aliases."
}
},
"SourceEvidence": [
{
"Name": "US OFAC Specially Designated Nationals List",
"ShortName": "us_ofac_sdn",
"RecordReference": "sample-sdn-0001",
"ListVersion": "us_ofac_sdn:sample",
"PublishedAt": "2026-08-17",
"DataOrigin": "publisher_direct",
"Attribution": null
}
],
"FieldEvidence": {
"lastName": [
{
"value": "PERSON",
"source": "us_ofac_sdn",
"recordReference": "sample-sdn-0001",
"listVersion": "us_ofac_sdn:sample"
}
]
},
"DataSource": {
"Name": "US OFAC Specially Designated Nationals List",
"ShortName": "us_ofac_sdn",
"RecordReference": "sample-sdn-0001",
"ListVersion": "us_ofac_sdn:sample",
"PublishedAt": "2026-08-17",
"DataOrigin": "publisher_direct",
"Attribution": null
},
"Program": [
"SDGT"
],
"ListedOn": "2024-01-15",
"Designation": "Sample designation for documentation",
"Comments": "Linked To: SAMPLE MATCH ENTITY",
"Remarks": "Linked To: SAMPLE MATCH ENTITY Listed on 2024-01-15",
"remarks": "Linked To: SAMPLE MATCH ENTITY Listed on 2024-01-15",
"sanctions": "Linked To: SAMPLE MATCH ENTITY Listed on 2024-01-15",
"Relationships": [],
"name": "SAMPLE MATCH PERSON",
"aliases": "SAMPLE MATCH ALIAS",
"schema": "Person",
"entity_type": "Person",
"countries": "ZA",
"birth_date": "1980-01-01",
"addresses": "",
"identifiers": "",
"score": 0.5,
"matched_name": "SAMPLE MATCH PERSON",
"source": "US OFAC Specially Designated Nationals List",
"source_key": "us_ofac_sdn",
"source_record_id": "sample-sdn-0001",
"source_version": "us_ofac_sdn:sample",
"dataset": "default",
"dataset_version": "aml_20260817_sample"
}
]
},
"JurisdictionRisks": {
"Found": false,
"Message": "No jurisdiction risk indicators found",
"RecordCount": 0,
"Results": []
}
},
"remainingCredits": 1840,
"screened_name": "SAMPLE MATCH PERSON",
"screened_entity_type": "Person",
"screened_country": "ZA",
"screened_dataset": "all",
"operation": "onboarding"
}Clear / negative · operation ongoing
{
"success": true,
"requestId": "rescreen-sample-clear-01",
"results": {
"Success": true,
"ResponseCode": 200,
"Messages": [
"No possible matches found in the categories checked"
],
"Header": {
"SearchDate": "2026-08-17T08:00:00.000Z",
"ReportName": "SAMPLE MATCH PERSON",
"ReportReference": "amlmon_rescreensampleclear0100000000000",
"ClientReference": "rescreen-sample-clear-01",
"ReportType": "Ongoing Financial Crime Monitoring",
"AuditReference": "amlmon_rescreensampleclear0100000000000",
"DatasetVersion": "aml_20260817_sample",
"DatasetPublishedAt": "2026-08-17T07:12:00.000Z",
"ScreenedAt": "2026-08-17T08:00:00.000Z",
"CategoriesRequested": [
"sanctions",
"crime",
"wanted",
"regulatory",
"debarment",
"pep",
"rca"
],
"DataOrigin": "publisher_direct"
},
"SearchResults": {
"InputName": "SAMPLE MATCH PERSON",
"InputMinScore": "90",
"InputIdentifierMatchBoostingThreshold": "",
"InputCountry": "ZA",
"Found": false,
"Message": "No possible matches found in the categories checked",
"RecordCount": 0,
"EntityMatchCount": 0,
"JurisdictionRiskCount": 0,
"HasNextPage": false
},
"PossibleMatches": {
"Found": false,
"Message": "No possible matches found in the categories checked",
"HasNextPage": false,
"Results": []
},
"JurisdictionRisks": {
"Found": false,
"Message": "No jurisdiction risk indicators found",
"RecordCount": 0,
"Results": []
}
},
"remainingCredits": 1840,
"screened_name": "SAMPLE MATCH PERSON",
"screened_entity_type": "Person",
"screened_country": "ZA",
"screened_dataset": "all",
"operation": "ongoing"
}Matching, coverage and ongoing screening
Names are compared with listed names and aliases using fuzzy matching, including spelling variations and name order. Supplied birth dates and other identifying details influence the score where the source contains them. Conflicting details can lower the score. The default threshold is 90 out of 100, configured at service level. It expresses a matching score rather than the probability of a confirmed identity; the API has no per-call threshold setting.
Results are potential matches with source evidence for customer review. Customers record their decisions in their own compliance system. VerifyNow has no false-positive dismissal or suppression workflow, and no validated false-positive percentage is published.
UN-based designations relevant to the FIC targeted financial sanctions framework are screened through the direct UN Security Council consolidated feed. That feed is checked hourly; validated changes are published after collection and processing. The schedule is not a one-hour publication SLA. Separate South African domestic designations and freezing orders are not represented as a complete corpus.
South African PEP feeds include national executive and municipal leadership records. Wider coverage draws on public government, parliamentary and leadership records, with relationship evidence where supplied. Complete provincial, SOE, Africa-wide PEP and comprehensive RCA coverage is not guaranteed. Available designations, relationships and source evidence support customer assessment. Complete role dates and a dedicated foreign/domestic PEP or prominent-influential-person classification are not guaranteed.
A dataset-change webhook prompts your integration to submit rescreens. Per-subject new-hit and cleared-hit alerts are not provided. Customer dataset-update emails are optional and off by default. The default licensed rate is 1,000 requests per minute per organisation, shared across its keys. Queue population rescreens, limit concurrency and honour Retry-After on HTTP 429. Reuse the same idempotency key when retrying the same request.
A numeric customer_reference can identify a person or company enrolment when an official identifier is unavailable. Keep it unique across the organisation and stable across rescreens. The reference does not affect the match score. Read the identifier requirements. Adverse Media Search is a separate endpoint.
Withdraw
Remove the subject from the active monitoring population when the relationship ends. Send the same identifier used at enrol. Keep each returned screening result in your record system. VerifyNow keeps the encrypted replay copy for 48 hours and retains enrolment and operational audit metadata for seven years.
POST /api/external/aml-ongoing/withdrawRequest
curl -X POST https://www.verifynow.co.za/api/external/aml-ongoing/withdraw \
-H "x-api-key: $VERIFYNOW_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"entity": 0,
"identifierType": "sa_id",
"identifierValue": "8001015009087"
}'Response
{
"success": true,
"withdrawn": true,
"subjectId": "3d4d83b0-0f76-4b58-9e6b-6b45cfac2db2"
}Dataset webhook and email
Customer dataset-update emails are optional and off by default. Account owners and admins can enable them in Settings → Ongoing AML, next to the webhook settings. Webhooks remain the primary notification method. Operational email alerts about degraded sources and service health go to VerifyNow administrators.
The webhook reports dataset and source changes. It is not a per-entity hit or cleared callback. When a customer-visible list actually adds, updates, or removes records, VerifyNow sends aml_monitoring.dataset_updated. When a monitored source is not current, it sends aml_monitoring.source_stale. Both use an HMAC-SHA256 signature. Organisation owner and admin contacts also receive an email. TFS source changes are highlighted in that email.
Set the HTTPS URL in your account: Settings → Ongoing AML → Dataset update webhook. The tab shows licence status and webhook setup. Saving requires organisation-settings access. Paste the URL, choose Save webhook, and store the signing secret immediately — it is shown once. There is no /api/external/... webhook registration.
From a signed-in dashboard session you can also GET /api/aml-monitoring/settings, or POST that same path with the JSON below. Set webhook_url to null to disable. The save response includes webhook_secret once. These routes use the dashboard session, not x-api-key.
{
"webhook_url": "https://example.com/webhooks/verifynow-aml"
}Send a test from that same section with Send test event, or POST /api/aml-monitoring/webhook-test. The test event type is aml_monitoring.webhook_test.
These are notifications. Enrolled subjects are not rescreened automatically. After a dataset change, POST the same name and identifier to /api/external/aml-ongoing, or rescreen on the review dates in your RMCP.
Event types
| Field | Value |
|---|---|
| aml_monitoring.dataset_updated | A monitored dataset version changed. Includes source change counts. |
| aml_monitoring.source_stale | A monitored source is not current. |
| aml_monitoring.webhook_test | Sent when you choose Send test event, or POST /api/aml-monitoring/webhook-test. |
Webhook payload
{
"id": "evt_amlmon_aml_20260817_sample",
"type": "aml_monitoring.dataset_updated",
"createdAt": "2026-08-17T07:12:00.000Z",
"data": {
"datasetVersion": "aml_20260817_sample",
"publishedAt": "2026-08-17T07:12:00.000Z",
"changes": [
{
"source": "us_ofac_sdn",
"title": "US OFAC Specially Designated Nationals List",
"added": 12,
"updated": 3,
"removed": 2
}
],
"sourceStatus": "current",
"dataOrigin": "publisher_direct"
}
}Source stale payload
{
"id": "evt_amlmon_source_sample",
"type": "aml_monitoring.source_stale",
"createdAt": "2026-08-17T07:12:00.000Z",
"data": {
"source": "us_ofac_sdn",
"title": "US OFAC Specially Designated Nationals List",
"status": "stale",
"version": "aml_20260817_sample",
"lastCheckedAt": "2026-08-17T07:12:00.000Z",
"lastSuccessAt": "2026-08-16T07:12:00.000Z"
}
}Test event
{
"id": "evt_amlmon_test_sample",
"type": "aml_monitoring.webhook_test",
"createdAt": "2026-08-17T07:12:00.000Z",
"data": {
"message": "VerifyNow AML monitoring webhook test"
}
}x-verifynow-event-idStable ID for duplicate handlingx-verifynow-timestampUnix timestamp in secondsx-verifynow-signaturev1=<hex HMAC-SHA256>Verify the signature
import crypto from 'node:crypto';
import express from 'express';
const app = express();
const secret = process.env.VERIFYNOW_WEBHOOK_SECRET;
const seenEvents = new Set();
app.post(
'/webhooks/verifynow-aml',
express.raw({ type: 'application/json' }),
(req, res) => {
const rawBody = req.body.toString('utf8');
const timestamp = req.header('x-verifynow-timestamp') || '';
const received = req.header('x-verifynow-signature') || '';
const eventId = req.header('x-verifynow-event-id') || '';
const expected =
'v1=' +
crypto
.createHmac('sha256', secret)
.update(timestamp + '.' + rawBody)
.digest('hex');
const validLength = expected.length === received.length;
const validSignature =
validLength &&
crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(received));
const fresh = Math.abs(Date.now() / 1000 - Number(timestamp)) <= 300;
if (!validSignature || !fresh) return res.sendStatus(401);
if (seenEvents.has(eventId)) return res.sendStatus(200);
seenEvents.add(eventId);
const event = JSON.parse(rawBody);
if (event.type === 'aml_monitoring.dataset_updated') {
// Rescreen enrolled subjects on your RMCP cadence.
}
// aml_monitoring.source_stale and aml_monitoring.webhook_test are
// notifications only.
return res.sendStatus(200);
},
);
app.use(express.json());
app.listen(3000);Errors
A new enrol that would exceed the licensed population returns HTTP 403. The licence size stays as contracted. The API does not auto-upgrade.
{
"error": "POPULATION_LIMIT_EXCEEDED",
"message": "Licensed monitoring population exceeded"
}| Field | Value |
|---|---|
| 401 | Missing or invalid x-api-key |
| 400 | Invalid body, identifier, dataset, or missing Idempotency-Key |
| 402 INSUFFICIENT_CREDITS | First enrol needs AML/PEP credits on the API-key balance |
| 403 POPULATION_LIMIT_EXCEEDED | Licensed monitoring population is full |
| 403 AML_LICENCE_REQUIRED | Active VerifyNow AML™ licence required for ongoing rescreens |
| 403 FULL_FINANCIAL_CRIME_REQUIRED | The active licence has an older restricted configuration. PEP and RCA are included in VerifyNow AML™; contact support to correct the licence configuration. |
| 429 RATE_LIMITED | Retry after the Retry-After header |
| 202 pending | A screen for that key is already in progress. Retry after Retry-After |
Credits and licence
First enrol
The first screen for a name and identifier uses the same credits as AML/PEP screening.
Same-subject rescreen
Later screens of that enrolled identifier use 0 credits within the active licence population and request limit.
Annual licence
Population is sized to your customer book. Buy an annual licence.
See the main API reference for shared authentication, credits, and idempotency rules.