Skip to main content
POST
compliance.aml.score

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
countryCode
string
required

ISO 2-letter country code.

Required string length: 1 - 20000
entityName
string
required

Name of person or company.

Required string length: 1 - 512
adverseMediaMatch
boolean

Whether adverse media was found.

entityType
string

Type of entity: person or company (default: person).

Required string length: 1 - 512
pepMatch
boolean

Whether entity is a Politically Exposed Person.

sanctionsMatch
boolean

Whether entity appears on sanctions lists.

Response

The result

entityName
string
required

Entity name.

riskScore
number

Risk score.

countryCode
string

Country code.

entityType
string

Entity type.

inputsReceivedAdverseMediaMatch
boolean

True when inputs received adverse media match.

inputsReceivedPepMatch
boolean

True when inputs received pep match.

inputsReceivedSanctionsMatch
boolean

True when inputs received sanctions match.

jurisdictionRisk
string

Jurisdiction risk.

recommendation
string

Recommendation.

riskLevel
string

Risk level.

scoredAt
string

Scored at, ISO 8601.