AML & ID validate

These two checks work on identity data rather than images. AML screens a person against sanctions and watchlists. ID validate checks a national ID number and, where supported, confirms the name and date of birth associated with it. AML needs the verify:aml scope; ID validate needs the verify:idvalidate scope.

AML screening

Submit a name (either fullName or firstName plus lastName) with optional dob, country, and idNumber to narrow matches.

POST
/v1/verify/aml
curl -X POST https://verify.lioncapventures.com/v1/verify/aml \
  -H "Authorization: Bearer svk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "fullName": "Tapiwa Moyo",
    "dob": "1990-04-12",
    "country": "ZW"
  }'

Response

{
  "status": "clear",
  "configured": true,
  "matches": []
}
  • Name
    status
    Type
    string
    Description

    clear when there are no hits, or a status indicating potential matches to review.

  • Name
    configured
    Type
    boolean
    Description

    Whether an AML data provider is configured for your organization. See below.

  • Name
    matches
    Type
    array
    Description

    Any watchlist hits, each with the matched entry and why it matched.

ID validation

Submit an idNumber with optional country, firstName, lastName, and dob to cross-check.

POST
/v1/verify/id-validate
curl -X POST https://verify.lioncapventures.com/v1/verify/id-validate \
  -H "Authorization: Bearer svk_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "idNumber": "63-1234567-A-42",
    "country": "ZW",
    "firstName": "Tapiwa",
    "lastName": "Moyo"
  }'

Response

{
  "status": "valid",
  "configured": true,
  "fields": {
    "firstName": "match",
    "lastName": "match",
    "dob": "not_checked"
  }
}
  • Name
    idNumber
    Type
    string (required)
    Description

    The national ID number to validate.

  • Name
    country
    Type
    string
    Description

    ISO 3166-1 alpha-2 country code, for example ZW.

  • Name
    fields
    Type
    object
    Description

    Per-field cross-check result, for example whether the submitted name matches the ID record.

The configured flag

Both endpoints return a configured flag. When configured is false, no AML or ID data provider is wired up for your organization yet, so the check cannot return a real result. Check configured before acting on status, and treat an unconfigured provider as "unknown", not "clear".

Was this page helpful?