Schemas

Full name of the individual to search for

Filter by specific sanctions sources. If omitted, all sources are searched.

Filter by ISO 3166-1 alpha-2 country codes to narrow results to specific jurisdictions

Full name of the individual to search for

When true, bypasses cached results and runs a fresh search against all data sources. Default: false.

When true, only returns profiles flagged as high-risk (PEPs, sanctioned individuals, adverse media matches). Set to false to include all matching profiles. Default: true.

Document type (e.g. "passport", "national_id")

Document number or identifier

Additional details about the document

IDs of source documents referencing this identification

Full name of the associate or relative

Relationship to the dossier subject (e.g. "spouse", "business partner", "sibling")

Brief description of the association

IDs of source documents supporting this association

Title or role held (e.g. "Minister of Finance")

Organization or body where the position was held

Time period of the position (e.g. "2015–2020")

Description of the role and responsibilities

Date this information was current as of

IDs of source documents supporting this position

Excerpt from source material

PEP likelihood score from 0.0 (unlikely) to 1.0 (certain)

PEP category (e.g. "Head of State", "Senior Government Official", "State-Owned Enterprise Executive")

Step-by-step reasoning explaining how the PEP score was derived

Overall risk score from 0.0 (low risk) to 1.0 (high risk)

Narrative explanation of the risk assessment

Risk category classification (e.g. "high", "medium", "low")

PEP-specific scoring breakdown (present when PEP indicators are found)

Unique identifier for this individual

Full name of the individual

Countries associated with this individual

Known aliases and alternative names

Identification documents linked to this individual

Known close associates and family members

Known dates of birth (multiple entries when sources disagree)

One-line summary describing the individual

Known locations and addresses

Classification keywords (e.g. "pep", "sanctions", "adverse-media")

Political and professional positions held

AI-generated narrative summary of the individual and their risk profile

Timestamp when this dossier was created

IDs of supporting source documents

Full source documents used to compile this dossier

AI-generated risk scorecard including PEP analysis and overall risk assessment

Whether this result was served from cache

Document type (e.g. "passport", "national_id", "drivers_license")

Document number or identifier

ISO 3166-1 alpha-2 country code of the issuing country

Full name of the individual to screen

Your own reference ID for this screening request (e.g. customer ID, case number). Useful for correlating results with your internal systems.

Identification document details to improve match accuracy. When provided, the screening engine uses these details to reduce false positives.

Date of birth in YYYY-MM-DD format

ISO 3166-1 alpha-2 country code of the individual's nationality or residence

Unique ID of the created screening request. Use this to track the request status and retrieve results.

External reference ID from your system, used to correlate this session with your records.

Session expiry duration in milliseconds. Defaults to 1 hour (3,600,000 ms).

Customer email address. When provided along with customerName, an invitation email with the session link is sent automatically.

Customer display name, used in the invitation email greeting.

Selected country code.

Selected document type.

Document aspect ratio (width / height).

Whether the document has both front and back sides.

Document processor instance ID.

Processor definition ID used for this verification.

Processing status.

Timestamp when verification was triggered (Unix ms).

Human-readable status label.

Detected document type identifier.

Timestamp when verification completed (Unix ms). Null while in progress.

Error message if processing failed, null on success.

Full processing result including validation, extraction, and post-processing data.

Per-stage progress entries showing each pipeline stage and its status.

Chronological processing log with timestamps for each stage.

Processing files with references to original, cropped, and detected face images.

Whether the face on the document matches the liveness frame.

Computed distance between the two face embeddings (lower = more similar).

Distance threshold used for the verification decision.

Face recognition model used.

Timestamp when the verification was performed (Unix ms).

Error message if the verification failed, null on success.

Unique session identifier.

Organization that owns this session.

Current session state.

Session data including country and document type selections.

Whether the session has been flagged as invalid (e.g. exceeded attempt limit).

Whether the KYC verification flow has been completed.

Session creation timestamp (Unix ms).

External reference ID provided at creation.

Customer display name.

Customer email address.

Session expiry timestamp (Unix ms). Null after completion.

Completion timestamp (Unix ms). Null if not yet completed.

Document verification result, populated once document images are processed.

Face verification result comparing the document photo with a liveness frame.

The created KYC session.

Short-lived JWT token for customer access to the session.

Full URL the customer should visit to complete KYC verification.

Free-text search across session ID, external ID, customer name, and email.

Filter by session state.

Filter by completion status.

Filter by invalid/flagged status.

Filter by creation date range (start/end as ISO 8601 strings).

Field to sort by.

Sort direction.

Maximum number of results to return (1–100).

Number of results to skip for pagination.

List of KYC sessions matching the query.

Total number of sessions matching the filters (before pagination).

Whether the deletion was successful.

MIME type of the file (e.g., image/jpeg, application/pdf)

Base64 encoded file data (required if url is not provided)

URL to fetch the file from (required if base64Data is not provided)

Original filename (optional)

ID of the document processor to use.

Array of files to process (provide base64 data or URL for each file)

Optional key-value context passed to the AI for cross-checking extracted document fields against known values.

INVOICE — supported keys:

• expectedVendor — supplier name to verify against the document
• expectedAmount — total amount to verify against the document

SRI_LANKA_ID — supported keys:

• name — full name to match against the document
• dateOfBirth — expected date of birth (YYYY-MM-DD)
• idNumber — NIC or passport number to verify
• address — residential address to compare (warning-level check)

Whether to crop images before processing (default: true). When true, document images are cropped before validation and extraction.

Whether processing should happen in the background (default: true). If true, validation and extraction are performed asynchronously; if false, waits for all processing to complete before returning a response.