SanctionSearchInput
fullNameFull name of the individual to search for
sourcesFilter by specific sanctions sources. If omitted, all sources are searched.
countriesFilter by ISO 3166-1 alpha-2 country codes to narrow results to specific jurisdictions
DossierSearchInput
fullNameFull name of the individual to search for
noCacheWhen true, bypasses cached results and runs a fresh search against all data sources. Default: false.
onlyShowHighRiskProfilesWhen true, only returns profiles flagged as high-risk (PEPs, sanctioned individuals, adverse media matches). Set to false to include all matching profiles. Default: true.
PersonIdentificationDocument
typeDocument type (e.g. "passport", "national_id")
numberDocument number or identifier
descriptionAdditional details about the document
referenceDocumentIdsIDs of source documents referencing this identification
AssociatesAndRelatives
nameFull name of the associate or relative
relationshipRelationship to the dossier subject (e.g. "spouse", "business partner", "sibling")
descriptionBrief description of the association
referenceDocumentIdsIDs of source documents supporting this association
PositionsHeld
positionTitle or role held (e.g. "Minister of Finance")
organizationOrganization or body where the position was held
periodTime period of the position (e.g. "2015–2020")
descriptionDescription of the role and responsibilities
asOfDateDate this information was current as of
referenceDocumentIdsIDs of source documents supporting this position
supportingTextExcerpt from source material
Document
idoriginalUrltitlebodyPEPScorecard
pepLikelihoodScorePEP likelihood score from 0.0 (unlikely) to 1.0 (certain)
categoryPEP category (e.g. "Head of State", "Senior Government Official", "State-Owned Enterprise Executive")
reasoningStepsStep-by-step reasoning explaining how the PEP score was derived
RiskScorecard
overallRiskScoreOverall risk score from 0.0 (low risk) to 1.0 (high risk)
riskReasoningNarrative explanation of the risk assessment
riskCategoryRisk category classification (e.g. "high", "medium", "low")
PEP-specific scoring breakdown (present when PEP indicators are found)
IndividualDossier
idUnique identifier for this individual
fullNameFull name of the individual
countriesCountries associated with this individual
otherNamesKnown aliases and alternative names
Identification documents linked to this individual
Known close associates and family members
dateOfBirthKnown dates of birth (multiple entries when sources disagree)
taglineOne-line summary describing the individual
locationsKnown locations and addresses
keywordsClassification keywords (e.g. "pep", "sanctions", "adverse-media")
Political and professional positions held
individualSummaryAI-generated narrative summary of the individual and their risk profile
createdAtTimestamp when this dossier was created
documentIdsIDs of supporting source documents
Full source documents used to compile this dossier
AI-generated risk scorecard including PEP analysis and overall risk assessment
cachedResultWhether this result was served from cache
IdentificationDocumentInput
typeDocument type (e.g. "passport", "national_id", "drivers_license")
numberDocument number or identifier
countryISO 3166-1 alpha-2 country code of the issuing country
CreateScreeningRequestDto
fullNameFull name of the individual to screen
externalIdYour 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.
dateOfBirthDate of birth in YYYY-MM-DD format
countryISO 3166-1 alpha-2 country code of the individual's nationality or residence
CreateScreeningRequestResponseDto
requestIdUnique ID of the created screening request. Use this to track the request status and retrieve results.
CreateKycSessionDTO
externalIdExternal reference ID from your system, used to correlate this session with your records.
expiresInMsSession expiry duration in milliseconds. Defaults to 1 hour (3,600,000 ms).
customerEmailCustomer email address. When provided along with customerName, an invitation email with the session link is sent automatically.
customerNameCustomer display name, used in the invitation email greeting.
KycSessionDataOutputDTO
countrySelected country code.
documentTypeSelected document type.
documentRatioDocument aspect ratio (width / height).
isDoubleSidedWhether the document has both front and back sides.
KycDocumentVerificationDTO
instanceIdDocument processor instance ID.
processorIdProcessor definition ID used for this verification.
statusProcessing status.
triggeredAtTimestamp when verification was triggered (Unix ms).
statusLabelHuman-readable status label.
documentTypeIdDetected document type identifier.
completedAtTimestamp when verification completed (Unix ms). Null while in progress.
errorError message if processing failed, null on success.
resultFull processing result including validation, extraction, and post-processing data.
stageProgressPer-stage progress entries showing each pipeline stage and its status.
processingLogChronological processing log with timestamps for each stage.
filesProcessing files with references to original, cropped, and detected face images.
KycFaceVerificationDTO
verifiedWhether the face on the document matches the liveness frame.
distanceComputed distance between the two face embeddings (lower = more similar).
thresholdDistance threshold used for the verification decision.
modelFace recognition model used.
performedAtTimestamp when the verification was performed (Unix ms).
errorError message if the verification failed, null on success.
KycSessionOutputDTO
idUnique session identifier.
organizationIdOrganization that owns this session.
stateCurrent session state.
Session data including country and document type selections.
isInvalidWhether the session has been flagged as invalid (e.g. exceeded attempt limit).
isCompleteWhether the KYC verification flow has been completed.
createdAtSession creation timestamp (Unix ms).
externalIdExternal reference ID provided at creation.
customerNameCustomer display name.
customerEmailCustomer email address.
expiresAtSession expiry timestamp (Unix ms). Null after completion.
completedAtCompletion 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.
CreateKycSessionOutputDTO
The created KYC session.
tokenShort-lived JWT token for customer access to the session.
sessionUrlFull URL the customer should visit to complete KYC verification.
KycSessionFiltersDTO
searchQueryFree-text search across session ID, external ID, customer name, and email.
stateFilter by session state.
isCompleteFilter by completion status.
isInvalidFilter by invalid/flagged status.
createdAtFilter by creation date range (start/end as ISO 8601 strings).
sortByField to sort by.
sortOrderSort direction.
limitMaximum number of results to return (1–100).
offsetNumber of results to skip for pagination.
PaginatedKycSessionsDTO
List of KYC sessions matching the query.
totalCountTotal number of sessions matching the filters (before pagination).
FileInput
mimeTypeMIME type of the file (e.g., image/jpeg, application/pdf)
base64DataBase64 encoded file data (required if url is not provided)
urlURL to fetch the file from (required if base64Data is not provided)
filenameOriginal filename (optional)
InitiateDocumentProcessingInput
processorIdID of the document processor to use.
Array of files to process (provide base64 data or URL for each file)
inputDataOptional 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 documentexpectedAmount— total amount to verify against the document
SRI_LANKA_ID — supported keys:
name— full name to match against the documentdateOfBirth— expected date of birth (YYYY-MM-DD)idNumber— NIC or passport number to verifyaddress— residential address to compare (warning-level check)
shouldCropImagesWhether to crop images before processing (default: true). When true, document images are cropped before validation and extraction.
backgroundProcessingWhether 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.

