API Reference

Create an identity verification monitor

post
https://api.wingspan.app/v3/onboarding/identity-verification-monitors

Subscribes the named subject to ongoing screening against OFAC / PEP / adverse-media sources. Only screening-type check types are monitorable; other types return 422 UnsupportedValue on monitoredCheckTypes[].

Only one active monitor is permitted per (subject.type, subject.id, tier) tuple — duplicates return 409 VerificationMonitorAlreadyExists.

If externalId is supplied and already used by another resource of this type for the owning Account, the request returns 409 ResourceConflict; create is not an upsert. Use filter[externalId][eq] on the list endpoint to retrieve the existing resource.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating an IdentityVerificationMonitor.

string
length ≤ 200
string

Optional anchor to the verification that produced this monitor. When omitted, the monitor is created standalone (e.g., compliance team subscribing to ongoing screening without an immediately preceding verification run).

subject
object
required

Identifies the party a record is about. Payee, Payer, and Stakeholder subjects use
stable relationship record IDs.

TypeAccess rule
AccountCaller must be able to act on that Account.
PersonCaller must be that Person or have delegated access to that Person.
PayeeCaller must be able to act on the payer side of that Payee record.
PayerCaller must be able to act on the payee side of that Payer record.
StakeholderCaller must be able to act on the Account that owns the Stakeholder.
string
enum
required

Wingspan-managed bundle of checks. Bundle membership is versioned via the Wingspan-Version header — adding a check to a tier is a minor bump; removing or replacing is a major bump.

  • Tax — TinMatch + KybLite. Fast, often sync. - BankingGrade — Tax + KybFull + OfacScreening + PepScreening + AdverseMedia + UboCollection. Mixed sync/async. - Enhanced — BankingGrade + DocumentVerification + LivenessCheck + BiometricMatch. Always involves user interaction.

KybLite and KybFull are individual check types (see IdentityVerificationCheckType), not tiers. To extend a tier with additional checks, use additionalCheckTypes on the create request.

Allowed:
string
enum
Defaults to Monthly

How often the monitor re-screens the subject. Discrete cadences run on a scheduled basis; default cadence is Monthly.

Allowed:
monitoredCheckTypes
array of objects

Only screening-type checks are monitorable (OfacScreening, PepScreening, AdverseMedia); other types return 422 UnsupportedValue.

monitoredCheckTypes
metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?