AML Screening API
Screen a person or an entity against sanctions, enforcement and regulatory watch lists and adverse media in one call, with every hit scored.
The documentation opens in the VerifyAll dashboard after sign-in, for accounts with approved API access. New to the API? Start with the developer guide.
Overview
What the AML Screening API does
The AML Screening API checks a name against anti-money-laundering, counter-terrorist-financing, non-compliance and lending watch lists, sanctions lists and adverse media, and answers in the same call. It works for a person or for an entity such as a company, LLP, firm or trust, and returns a match status, the lists that returned hits, and each hit with its score and details.
Each hit carries an overall match score and a name similarity score from 0 to 100, the risk areas the list covers (AML, CFT, lending, non-compliance), the date and country on the entry, and for adverse media the headline, an excerpt and a link to the public article. Where a regulator has acted, the hit lists the action, the charges and the persons named. Your analysts see why a name matched instead of a bare yes or no.
Send a PAN or CIN and a date of birth or incorporation to sharpen the match, and up to five aliases to catch other spellings. Results are stored in your account history with a checkResultId and can be downloaded as a PDF for the customer file.
How it works
- 1
Send POST /universal/negative-due-diligence with name, subject_type (individual or entity), the consent object and, if you have them, an identifier, a date and aliases.
- 2
The request is validated first; a missing field or a malformed identifier is refused with 400 and every problem listed, before any charge.
- 3
The name is screened and the answer returns in the same call, usually within about 5 seconds, with match_status, the lists hit and the scored hits, charged from your prepaid wallet.
- 4
The result is stored with a checkResultId: read it again with GET /check-results/{id}, find it by your client_ref, and download the PDF with POST /pdf-reports/aml.
Request and response
AML screening API endpoints and fields
The main fields; the full reference with every field, error code and a cURL sample is in the dashboard docs.
| Endpoint | What it does |
|---|---|
| POST/universal/negative-due-diligence | Screen a person or entity name against watch lists and adverse media |
| GET/check-results/{id} | Read a stored screening result again |
Request fields
| Field | What it is |
|---|---|
| nameRequired | Full name of the person, or registered name of the entity, 2 to 160 characters. |
| subject_typeRequired | individual for a person; entity for a company, LLP, firm or trust. |
| identifierOptional | PAN for an individual, or CIN or PAN for an entity, to sharpen the match. |
| date / date_exact_matchOptional | Date of birth or of incorporation (YYYY-MM-DD), and whether it must match exactly (true by default when a date is sent). |
| aliasesOptional | Up to 5 other names the subject is known by. |
| consentRequired | obtained: true and a purpose of up to 200 characters. |
| client_refOptional | Your reference, stored with the result. |
What the answer returns
| Field | What it is |
|---|---|
| match_status | match_found (at least one list matched), possible_match (matches need review) or no_match. |
| hit_count / lists | How many hits, and each list that returned a hit with its category (sanctions, enforcement, regulatory, adverse_media and others) and hit count. |
| hits[].score / name_score | Overall match score and name similarity, each 0 to 100; hits come highest score first. |
| hits[].relevance | The risk areas the list is relevant to, such as AML, CFT, LENDING and NONCOMPLIANCE. |
| hits[].title / summary / source_url | For adverse media: the headline, an excerpt of up to 1,000 characters and the link to the public article or notice. |
| hits[].actions / related_persons | Regulatory actions on the entry (who acted, the action and the charges) and the persons named with them. |
| hits[].country / date / address / alias / designation | The other details on the entry, where recorded. |
Base URL https://api.verifyall.ai. Authenticate with the X-API-Key header (a va_sandbox_ or va_live_ key). Every answer carries data, status_code, success, message and message_code; checks add outcome, checkResultId, charged and charged_amount.
Key features
AML Screening API features and capabilities
Scored, explainable hits
Every hit has a match score and a name score, so you can set your own review threshold and show analysts why a name matched.
People and entities
One endpoint screens individuals and companies, LLPs, firms or trusts; subject_type tells the screening which kind of name it is.
Narrower matches on common names
A PAN or CIN, a date of birth or incorporation with exact matching, and known aliases narrow common names to the right subject.
Stored for audit
Each screening is kept with a checkResultId and a PDF, so the evidence of when a customer was screened stays with the account.
Use cases
Where businesses use the AML Screening API
Customer onboarding (KYC)
Screen every new customer or account holder at sign-up and route possible matches to compliance.
Vendor and counterparty due diligence
Screen suppliers, distributors and their promoters before payment terms or contracts are agreed.
Lending risk
Check borrowers and guarantors against lending and enforcement lists and adverse media before sanction.
Periodic re-screening
Screen existing customers again on a schedule or on a trigger, and compare the result with the stored one.
Industries
Coverage
Names of individuals and entities, screened against sanctions, enforcement, regulatory and lending watch lists and adverse media. Indian identifiers (PAN, CIN) sharpen the match.
Limitations to plan for
- Screening matches names; a hit is not proof that your customer is the person or entity on the list. Review possible matches before acting.
- Common names without an identifier, a date or aliases return more hits to review.
- A screening with no hits is a completed check and is charged.
- Every request carries the consent object, including screenings of an entity.
Integration
How to integrate the AML Screening API
From a business account to your first live call.
Step 1
Create a business account on VerifyAll and get it approved, as for running checks in the dashboard.
Step 2
Request Developer API access under Developers in the dashboard: the APIs you need, your expected monthly volume and your use case. The VerifyAll team reviews it and shares the API Services Agreement.
Step 3
Once the agreement is signed and access is approved, create your Sandbox key and build against sample data. Sandbox calls are never charged.
Step 4
Create your Production key, recharge your wallet and switch the key in your code: the endpoint and fields stay the same.
Get started
Request access to the AML Screening API
Tell us what you want to verify. We reply within one business day with access steps, Sandbox details and your API pricing.
View API documentation
The full reference for AML Screening API (endpoints, fields, errors, cURL) opens in the dashboard once your access is approved.
Open the docs (sign-in)Create a business account
API keys are issued to an approved business account. Sign up, then request access under Developers.
Create account
Pricing
Production calls are charged per check from your prepaid VerifyAll wallet, at your account’s API price; GST is added separately when you recharge. Sandbox calls are never charged. Your API prices are shown in the dashboard once access is approved. How pricing works
Already have a business account? Sign in to request access
AML Screening API: frequently asked questions
Answers for teams planning an integration.
Still have questions? Our team is happy to help.
Contact SupportRelated APIs
Court Records Verification API
LiveFinishes laterFind the civil and criminal court cases of a person or a business, with each case’s court, status and next hearing, in one asynchronous API.
View API detailsPAN Verification API
LiveInstant answerConfirm a PAN exists, see who holds it and match the name and date of birth your customer typed, in one call.
View API detailsBasic Business Verification API
LiveFinishes laterOne request runs the business checks a KYB review needs and returns one report with an overall result.
View API detailsBackground Verification API
LiveFinishes laterRun the background checks you choose on one person in a single request, and read back one report with an overall result and every check’s outcome.
View API details
All legal and AML APIsRun AML screening in the dashboard, without codeBrowse the API Marketplace
Start with the AML Screening API
Request access, build against the Sandbox, then go live with your Production key.