KYC API Enums Reference

This page documents all enumerated values found in the FrankieOne KYC V2 API OpenAPI specifications. All values are extracted from v2-openapi.json and v2-fc-core-bundled_generated.yaml.

Entity & Profile Enums

Entity-Type

Source: v2-openapi.json → #/components/schemas/Entity-Type

Value	Description
`INDIVIDUAL`	Individual person entity
`ORGANIZATION`	Organization/business entity
`UNKNOWN`	Entity type not determined

Service-Profile-State

Source: v2-openapi.json → #/components/schemas/Service-Profile-State

Value	Description
`INIT`	Initial state when profile is created
`AUTO`	Automatically assigned state after initial processing
`ACTIVE`	Profile is active and in use
`ARCHIVED`	Profile has been archived and is no longer active
`BLOCKLISTED`	Profile is blocked from further actions
`INACTIVE`	Profile is inactive, not currently in use
`DELETED`	Profile has been deleted
`DUPLICATE`	Profile is a duplicate of another existing profile

Workflow Execution Enums

Workflow-Execution-ResultEnum

Source: v2-openapi.json → #/components/schemas/Workflow-Execution-ResultEnum

Value	Description
`UNCHECKED`	Workflow has not yet been run
`IN_PROGRESS`	Workflow is currently running
`REVIEW`	Workflow produced results requiring review
`PASS`	Workflow completed with PASS recommendation
`FAIL`	Workflow finished with FAIL recommendation
`COMPLETE`	Workflow finished, results complete (PASS/FAIL not required)
`INCOMPLETE`	Workflow finished, results incomplete
`NEEDS_APPROVAL`	Workflow requires approval process
`APPROVED`	Workflow was approved (typically by human)
`REJECTED`	Workflow was rejected (typically by human)
`BLOCKED`	Workflow blocked from completing, manual review required
`CLEAR`	Workflow completed with no issues (often for monitoring)
`URGENT`	Workflow completed with urgent matters requiring review
`MONITOR`	Workflow completed, further monitoring required

Workflow-Execution-StateEnum

Source: v2-openapi.json → #/components/schemas/Workflow-Execution-StateEnum

Value	Description
`COMPLETED`	Workflow execution completed successfully
`CANCELED`	Workflow execution was canceled
`TERMINATED`	Workflow execution terminated before completion
`ERROR`	Workflow execution encountered an error
`TIMEOUT`	Workflow execution timed out
`IN_PROGRESS`	Workflow execution currently in progress

Workflow-LifecyclePhaseEnum

Source: v2-openapi.json → #/components/schemas/Workflow-LifecyclePhaseEnum

Value	Description
`ONBOARDING`	Workflow is in onboarding stage
`MONITORING`	Workflow is in monitoring stage
`OTHER`	Workflow is in another stage

Workflow-Step-Type

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Workflow-Step-Type

Value	Description
`BLOCKLIST`	Blocklist check step
`DUPLICATE`	Duplicate detection step
`DECISION`	Decision step
`BRANCH`	Branch/routing step
`MONITOR_TOGGLE`	Monitoring toggle step
`OTHER`	Other step type
`KYC`	Know Your Customer step
`AML`	Anti-Money Laundering step
`IDV`	Identity Verification step
`START`	Workflow start step
`FINISH`	Workflow finish step

Workflow-Step-ResultEnum

Source: v2-openapi.json → #/components/schemas/Workflow-Step-ResultEnum

Value	Description
`UNCHECKED`	Step not attempted
`SKIPPED`	Step skipped (not required or previously run)
`MISSING_DATA`	Step requires additional data
`PASS`	Step completed, goals met
`FAIL`	Step completed, goals not met
`COMPLETE`	Step finished successfully (no pass/fail)
`INCOMPLETE`	Step unable to finish successfully
`MATCH`	Fully successful match against source(s)
`NO_MATCH`	No match against source(s)
`PARTIAL`	Partially successful match
`CLEAR`	No match found on negative list (positive outcome)
`HIT`	Match found on negative list
`CLEARED`	Previously found matches have been resolved
`EXPIRED`	Data has expired
`CLEAR_REVIEW`	Cleared but requires review
`HIT_ACCEPTED`	Hit found and accepted
`HIT_REJECTED`	Hit found and rejected
`NOT_APPLICABLE`	Step unnecessary (e.g., visa check for citizen)
`ERROR`	Unrecoverable error, no useful result

Process Result Enums

Process-ResultEnum

Source: v2-openapi.json → #/components/schemas/Process-ResultEnum

Value	Description
`MATCH`	Element check matched expected criteria
`PARTIAL_MATCH`	Element check partially matched
`INVALID_MATCH`	Element check matched but was invalid
`NO_MATCH`	Element check did not match
`CLEAR`	Element check was cleared
`HIT`	Element check hit specific condition
`BAD_DATA`	Element check encountered bad data
`CREATED`	Element check resulted in creation
`UPDATED`	Element check resulted in update
`DELETED`	Element check resulted in deletion
`FAIL`	Element check failed
`NOT_APPLICABLE`	Element check not applicable
`SUSPECTED`	Element check raised suspicion
`REJECTED`	Element check was rejected
`MANUAL`	Element check manually reviewed
`CLEAR_AUTO`	Element check cleared automatically
`OVERRIDE`	Element check overridden

Process-Result-StateEnum

Source: v2-openapi.json → #/components/schemas/Process-Result-StateEnum

Value	Description
`IN_PROGRESS`	Process in progress
`COMPLETED`	Process completed
`TIMEOUT`	Process timed out
`ERROR`	Process encountered error

Process-Result-System-StatusEnum

Source: v2-openapi.json → #/components/schemas/Process-Result-System-StatusEnum

Value	Description
`VALID`	Process result is valid
`EXPIRED`	Process result has expired
`STALE`	Process result is stale/outdated
`MARKED_INVALID`	Process result explicitly marked invalid
`MARKED_IGNORE`	Process result marked to be ignored

Process-Result-ClassEnum

Source: v2-openapi.json → #/components/schemas/Process-Result-ClassEnum

Value	Description
`KYC`	Know Your Customer
`ID`	Identity document
`IDV`	Identity Verification
`AML`	Anti-Money Laundering
`FRAUDLIST`	Fraud list
`FRAUDCHECK`	Fraud check
`FRAUD`	Fraud
`DEVICE`	Device
`MOBILE`	Mobile
`EMAIL`	Email
`LOOKUP`	Lookup
`CREATE`	Create operation
`UPDATE`	Update operation
`DELETE`	Delete operation
`KYB`	Know Your Business
`DUPLICATE`	Duplicate
`BLOCKLIST`	Blocklist
`SUPPORTING_DOC`	Supporting document
`MATCHLIST`	Matchlist
`VISA`	Visa
`ACTIVITY`	Activity

Process-Result-Manual-StatusEnum-AML

Source: v2-openapi.json → #/components/schemas/Process-Result-Manual-StatusEnum-AML

Value	Description
`TRUE_POSITIVE`	Result is true positive (not resolved)
`FALSE_POSITIVE`	Result is false positive (not resolved)
`TRUE_POSITIVE_ACCEPT`	True positive, resolved, accept activity
`TRUE_POSITIVE_REJECT`	True positive, resolved, reject activity
`UNKNOWN`	Result unknown (not resolved)
`UNKNOWN_ACCEPT`	Unknown result, resolved, accept activity
`UNKNOWN_REJECT`	Unknown result, resolved, reject activity

Process-Result-Manual-StatusEnum-KYC

Source: v2-openapi.json → #/components/schemas/Process-Result-Manual-StatusEnum-KYC

Value	Description
`PASS`	Result determined to be pass
`FAIL`	Result determined to be fail

Process-Result-Manual-StatusEnum-IDV

Source: v2-openapi.json → #/components/schemas/Process-Result-Manual-StatusEnum-IDV

Value	Description
`CLEAR`	Result determined to be clear
`REJECTED`	Result determined to be rejected

Process-Result-Manual-StatusEnum-Duplicate

Source: v2-openapi.json → #/components/schemas/Process-Result-Manual-StatusEnum-Duplicate

Value	Description
`FALSE_POSITIVE`	Entities are not duplicates, keep both
`TRUE_POSITIVE_ACCEPT`	Entities are duplicates, keep incoming (B) as primary
`TRUE_POSITIVE_REJECT`	Entities are duplicates, keep existing (A) as primary

Process-Result-Manual-StatusEnum-Matchlist

Source: v2-openapi.json → #/components/schemas/Process-Result-Manual-StatusEnum-Matchlist

Value	Description
`FALSE_POSITIVE`	Result is false positive
`TRUE_POSITIVE_REJECT`	True positive, reject activity

Process-Result-Manual-StatusEnum-Fraud

Source: v2-openapi.json → #/components/schemas/Process-Result-Manual-StatusEnum-Fraud

Value	Description
`FALSE_POSITIVE_ACCEPT`	False positive, acceptable risk
`FALSE_POSITIVE_REJECT`	False positive, unacceptable risk
`TRUE_POSITIVE_ACCEPT`	True positive, acceptable risk
`TRUE_POSITIVE_REJECT`	True positive, unacceptable risk

Risk Enums

Risk-Level

Source: v2-openapi.json → #/components/schemas/Risk-Level

Value	Description
`UNKNOWN`	Risk level not determined
`LOW`	Low risk
`MEDIUM`	Medium risk
`HIGH`	High risk
`UNACCEPTABLE`	Unacceptable risk level

Risk-Factor-Status

Source: v2-openapi.json → #/components/schemas/Risk-Factor-Status

Value	Description
`VALID`	Risk factor applicable to entity
`STALE`	Risk factor no longer applicable
`OVERRIDDEN`	Risk factor manually overridden
`DISCARDED`	Risk factor added but discarded in same workflow

Document Enums

Document-Type

Source: v2-openapi.json → #/components/schemas/Document-Type

Value	Description
`OTHER`	Generic/unspecified document
`DRIVERS_LICENSE`	Driver’s license
`PASSPORT`	Passport
`VISA`	Visa document (not Visa payment card)
`IMMIGRATION`	Immigration card
`NATIONAL_ID`	National ID card
`TAX_ID`	National tax identifier
`NATIONAL_HEALTH_ID`	National health program ID (Medicare, NHS)
`CONCESSION`	State-issued concession card
`HEALTH_CONCESSION`	State-issued health concession card
`PENSION`	State-issued pension ID
`MILITARY_ID`	Military ID
`BIRTH_CERT`	Birth certificate
`CITIZENSHIP`	Citizenship certificate
`MARRIAGE_CERT`	Marriage certificate
`DEATH_CERT`	Death certificate
`NAME_CHANGE`	Name change confirmation
`UTILITY_BILL`	Regulated utility bill
`BANK_STATEMENT`	Bank/card statement
`BANK_ACCOUNT`	Bank account
`INTENT_PROOF`	Proof of intent (photo/video/letter)
`ATTESTATION`	Document of attestation (Statutory Declaration)
`SELF_IMAGE`	Selfie for comparisons
`DEVICE`	Device ID
`VEHICLE_REGISTRATION`	Vehicle registration number
`PROOF_OF_ADDRESS`	Proof of address document
`HOUSE_REGISTRATION`	House registration document
`YELLOW_HOUSE_REGISTRATION`	Yellow House Registration Thor Ror 13
`WORK_PERMIT`	Work permit
`EMPLOYMENT_CERTIFICATE`	Certificate of employment
`NOTARY_PUBLIC_ID`	Notary Public Identification
`EXTERNAL_ADMIN`	Details of appointed administrator
`CHARGES`	Details of charges against company/director
`PRE_ASIC`	Pre-ASIC documents
`ANNUAL_RETURN`	Company annual return
`REPORT`	Frankie-generated report
`TRUST_DEED`	Corporate trust deed
`PARTNERSHIP_AGREEMENT`	Partnership agreement documents
`ADMIN_CHANGE`	Change of administrator
`COMPANY_REPORT`	Registry-filed company reports
`CHECK_RESULTS`	Results of checks completed outside Frankie
`AVIATION_SECURITY_ID`	Aviation Security Identification Card
`MARITIME_SECURITY_ID`	Maritime Security Identification Card

Document-Class

Source: v2-openapi.json → #/components/schemas/Document-Class

Value	Description
`OTHER`	Other/unspecified
`IDENTITY`	Identity document
`SUPPORTING`	Supporting document
`REPORT`	Report document

Document-Attachment-Side

Source: v2-openapi.json → #/components/schemas/Document-Attachment-Side

Value	Description
`FRONT`	Front side of document
`BACK`	Back side of document

Document-Attachment-Retrieval-Status

Source: v2-openapi.json → #/components/schemas/Document-Attachment-Retrieval-Status

Value	Description
`NORMAL`	Data retrieved and included
`EXCLUDED`	Data not included (not requested or deleted)
`FAILED`	Data could not be retrieved from secure store

Individual Entity Enums

Address-TypeEnum

Source: v2-openapi.json → #/components/schemas/Address-TypeEnum

Value	Description
`OTHER`	Other/unspecified address
`RESIDENTIAL`	Residential address
`BUSINESS`	Business address
`POSTAL`	Postal address
`REGISTERED_OFFICE`	Registered office address
`PLACE_OF_BUSINESS`	Place of business
`OFFICIAL_CORRESPONDANCE`	Official correspondence address
`PLACE_OF_BIRTH`	Place of birth
`OFFICE_LOCALITY`	Office locality

Address-StatusEnum

Source: v2-openapi.json → #/components/schemas/Address-StatusEnum

Value	Description
`CURRENT`	Current address
`PREVIOUS`	Previous address
`FUTURE`	Future address

GenderEnum

Source: v2-openapi.json → #/components/schemas/GenderEnum

Value	Description
`MALE`	Male
`FEMALE`	Female
`NON_BINARY`	Non-binary
`OTHER`	Other
`UNSPECIFIED`	Unspecified

Date-Type

Source: v2-openapi.json → #/components/schemas/Date-Type

Value	Description
`BUDDHIST`	Buddhist calendar
`DISCORDIAN`	Discordian calendar
`GREGORIAN`	Gregorian calendar (default)
`HEBREW`	Hebrew calendar
`ISLAMIC`	Islamic calendar
`JULIAN`	Julian calendar
`LUNAR`	Lunar calendar
`MESO_AMERICAN`	Meso-American calendar
`PERSIAN`	Persian calendar
`OTHER`	Other calendar system

Contact Information Enums

Phone Number Type

Source: v2-openapi.json → #/components/schemas/Phone-Number → type

Value	Description
`OTHER`	Other phone type
`WORK`	Work phone
`HOME`	Home phone
`MOBILE`	Mobile phone
`BUSINESS`	Business phone
`FAX`	Fax number

Email Type

Source: v2-openapi.json → #/components/schemas/Email → type

Value	Description
`OTHER`	Other email type
`WORK`	Work email
`PERSONAL`	Personal email
`BUSINESS`	Business email

Source: v2-openapi.json → #/components/schemas/Consent-Type-Param

Value	Description
`GENERAL`	General consent
`DOCS`	Document consent
`CREDITHEADER`	Credit header consent
`UNDER18`	Under 18 consent
`PAYROLL`	Payroll consent
`INSURANCE`	Insurance consent
`SUPERANNUATION`	Superannuation consent

Workflow Issue Enums

Workflow-Issue-Category

Source: v2-openapi.json → #/components/schemas/Workflow-Issue-Category

Value	Description
`AML`	Anti-Money Laundering issues
`BAD_DATA`	Invalid or incorrect data
`BIOMETRICS`	Biometrics check issues
`BLOCKLISTED`	Entity on blocklist
`DECEASED`	Entity is deceased
`DEVICE`	Device check issues
`DOCUMENT`	Document check issues
`DUPLICATE`	Entity has duplicates
`EXPIRY`	Process/document expired
`FRAUD`	Possible fraud detected
`IDV`	Identity Verification issues
`INFORMATIONAL`	Informational messages
`KYC`	Know Your Customer issues
`SYSTEM`	System-level issues
`VERIFY`	Verification issues
`VISA`	Visa check issues
`WATCHLIST`	Watchlist check issues
`ACTIVITY`	Activity process issues

Workflow-Issue-Type

Source: v2-openapi.json → #/components/schemas/Workflow-Issue-Type

Value	Category	Description
`AML_ISSUE`	AML	AML issue
`BAD_DATA_ADDRESS`	BAD_DATA	Address missing/unusable
`BAD_DATA_DOB`	BAD_DATA	Date of birth missing/unusable
`BAD_DATA_EMAIL`	BAD_DATA	Email missing/unusable
`BAD_DATA_ID`	BAD_DATA	ID missing/unusable
`BAD_DATA_MOBILE`	BAD_DATA	Mobile missing/unusable
`BAD_DATA_NAME`	BAD_DATA	Name missing/unusable
`BLOCKED`	BLOCKLISTED	Entity blocked
`COMPROMISED_DOCUMENT`	IDV	Document is compromised
`CREDIT_HEADER`	INFORMATIONAL	Credit header information
`DATA_COMPARISON`	IDV	Data comparison issue
`DATA_CONSISTENCY`	IDV	Data consistency issue
`DATA_VALIDATION`	IDV	Data validation issue
`DENY_LIST`	VISA	Visa deny list match
`DECEASED`	DECEASED	Person is deceased
`DEVICE_FRAUD_MATCH`	DEVICE	Device fraud detected
`DEVICE_INVALID`	DEVICE	Device is invalid
`DOCUMENT_COMPARISON`	IDV	Document comparison issue
`DUPLICATE`	DUPLICATE	Entity is duplicate
`FRAUD_CHECK`	FRAUD	Fraud detected during checks
`FRAUD_DEVICE`	FRAUD	Device fraud detected
`FRAUD_IP_ADDRESS`	FRAUD	IP address fraud detected
`FRAUD_EMAIL_ADDRESS`	FRAUD	Email address fraud detected
`FRAUD_PHONE_NUMBER`	FRAUD	Phone number fraud detected
`FRAUD_ISSUE`	FRAUD	Fraud issue
`FRAUD_LIST`	FRAUD	Entity on fraud list
`IMAGE_INTEGRITY`	IDV	Image integrity issue
`INTERNAL_MATCH`	WATCHLIST/BLOCKLISTED	Internal watchlist/blocklist match
`LIVENESS_DETECTION`	IDV	Liveness detection failed
`MATCHED_EXTERNAL`	BLOCKLISTED	External blocklist match
`MATCHED_INTERNAL`	BLOCKLISTED	Internal blocklist match
`MATCHED_SHARED`	BLOCKLISTED	Shared blocklist match
`MEDIA`	AML	Adverse media hits
`NOT_FOUND`	KYC	No match found
`OCR`	IDV	OCR data mismatch
`PARTIAL`	KYC	Partially successful KYC
`PEP`	AML	Politically Exposed Person hits
`REQUIRES_AML`	EXPIRY	AML needs re-initiation
`REQUIRES_IDV`	EXPIRY	IDV needs re-initiation
`REQUIRES_KYC`	EXPIRY	KYC needs re-initiation
`REQUIRES_VISA`	EXPIRY	Visa needs re-initiation
`SANCTION`	AML	Sanction hits
`SERVICE_ERROR`	SYSTEM	All providers returned error
`SERVICE_TIMEOUT`	SYSTEM	All providers timed out
`VISA_FAILED`	VISA	Visa check failed
`VISUAL_AUTHENTICITY`	IDV	Visual authenticity issue
`WATCHLIST`	AML	Watchlist hits
`ACTIVITY_AML`	ACTIVITY	AML-related activity issue
`ACTIVITY_FRAUD`	ACTIVITY	Fraud-related activity issue
`ACTIVITY_DEVICE`	ACTIVITY	Device-related activity issue

Workflow-Issue-Severity

Source: v2-openapi.json → #/components/schemas/Workflow-Issue-Severity

Value	Description
`INFO`	Informational only
`REVIEW`	Requires review
`BLOCK`	Blocks further processing
`WARNING`	Warning, not blocking
`CRITICAL`	Critical issue
`ERROR`	Error encountered

Monitoring & Subscription Enums

Monitoring-Type / Subscription-Type

Source: v2-openapi.json → #/components/schemas/Monitoring-Type

Value	Description
`AML`	Anti-Money Laundering monitoring
`ACTIVITY`	Activity monitoring

Subscription-Status

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Subscription-Status

Value	Description
`ENABLED`	Subscription is active and operational
`DISABLED`	Subscription is inactive

IDV (Identity Verification) Enums

IDV OCR Status

Source: v2-openapi.json → #/components/schemas/IDV-OCR-Response → status

Value	Description
`AWAITING_OCR_RESULTS_PROVIDER_OFFLINE`	Provider offline, OCR results unavailable
`AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE`	Document type not supported
`WAITING_DOCUMENT_UPLOAD_FAILED_OCR`	Document upload failed
`AWAITING_DOCUMENT_OCR`	Document being processed by provider
`DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT`	Document too large
`DOCUMENT_INVALID_INCORRECT_FILE_FORMAT`	Document format not supported
`AWAITING_DOCUMENT_UPLOAD_BACK`	Back of document needs upload
`AWAITING_DOCUMENT_UPLOAD_FRONT`	Front of document needs upload
`COMPLETE_OCR`	Document OCR valid and completed

IDV Process Status

Source: v2-openapi.json → #/components/schemas/IDV-InitProcess-Response → status

Value	Description
`IN_PROGRESS`	Provider processing request
`CHECK_PROCESSING_DOWNLOAD_FAIL`	Processing, image download issue (will retry)
`WAITING_SELFIE_UPLOAD`	Awaiting applicant selfie upload
`CHECK_PROCESSING`	Provider processing request
`DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT`	Document too large
`DOCUMENT_INVALID_INCORRECT_FILE_FORMAT`	Document format not supported
`PROVIDER_OFFLINE`	Provider not available
`COMPLETE`	Process valid and completed

Supplementary-Data-IDV-OCR-Comparison-Enum-Comparison-Source

Source: v2-openapi.json → #/components/schemas/Supplementary-Data-IDV-OCR-Comparison-Enum-Comparison-Source

Value	Description
`ENTITY`	Original entity data
`OCR_UPDATE`	Updated data from OCR scan

Matchlist Enums

Matchlist-Action

Source: v2-openapi.json → #/components/schemas/Matchlist-Action

Value	Description
`BLOCK`	Recommended action: block entity
`ALERT`	Recommended action: create alert
`ALLOW`	Recommended action: allow entity
`REVIEW`	Recommended action: review entity
`NONE`	No action, only use riskFactor

Matchlist-State

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Matchlist-State

Value	Description
`ACTIVE`	Matchlist active, can be used for matching
`ARCHIVED`	Matchlist archived, cannot be used

Matchlist-Entry-State

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Matchlist-Entry-State

Value	Description
`ACTIVE`	Entry active, can be used for matching
`EXPIRED`	Entry expired, visible but not used for matching
`DELETED`	Entry deleted, unusable

Matchlist-Entry-Attribute-Type

Source: v2-openapi.json → #/components/schemas/Matchlist-Entry-Attribute-Type

Value	Entity Type	Description
`ENTITY_TYPE`	Both	Entity type
`EMAIL_ADDRESS`	Both	Email address
`EMAIL_DOMAIN`	Both	Email domain
`PHONE_NUMBER`	Both	Phone number
`ADDR_STREET_NUMBER`	Both	Address street number
`ADDR_STREET_NAME`	Both	Address street name
`ADDR_STREET_TYPE`	Both	Address street type
`ADDR_NEIGHBORHOOD`	Both	Address neighborhood
`ADDR_LOCALITY`	Both	Address locality
`ADDR_DISTRICT`	Both	Address district
`ADDR_SUBDIVISION`	Both	Address subdivision
`ADDR_COUNTRY`	Both	Address country
`ADDR_POSTAL_CODE`	Both	Address postal code
`ADDR_UNSTRUCTURED_LONG_FORM`	Both	Unstructured address
`DOC_CLASS`	Both	Document class
`DOC_TYPE`	Both	Document type
`DOC_SUBTYPE`	Both	Document subtype
`DOC_PRIMARY_IDENTIFIER`	Both	Document primary ID
`DOC_SECONDARY_IDENTIFIER`	Both	Document secondary ID
`IND_DISPLAY_NAME`	Individual	Individual display name
`IND_GIVEN_NAME`	Individual	Individual given name
`IND_FAMILY_NAME`	Individual	Individual family name
`IND_MIDDLE_NAME`	Individual	Individual middle name
`IND_DATE_OF_BIRTH`	Individual	Individual date of birth
`IND_NATIONALITY`	Individual	Individual nationality
`ORG_REGISTERED_SUBDIVISION`	Organization	Organization registered subdivision
`ORG_REGISTERED_COUNTRY`	Organization	Organization registered country
`ORG_REGISTRATION_NUMBER`	Organization	Organization registration number
`ORG_REGISTRATION_NUMBER_TYPE`	Organization	Organization registration number type
`ORG_NAME`	Organization	Organization name

Search Enums

Search-Type

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Search-Type

Value	Description
`EXACT`	Returns only exact matches
`FUZZY`	Returns similar matches

Search-Field

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Search-Field

Value	Applies To	Description
`NAME`	Both	All name parts
`GIVEN_NAME`	Individual	Given name
`FAMILY_NAME`	Individual	Family name
`MIDDLE_NAME`	Individual	Middle name
`DISPLAY_NAME`	Individual	Display name
`OTHER_NAME`	Individual	Other names
`ADDRESS`	Both	Address (planned)
`EMAIL_ADDRESS`	Both	Email address (planned)
`PHONE_NUMBER`	Both	Phone number (planned)
`DOCUMENT_IDENTIFIER`	Both	Document identifiers (planned)
`EXTERNAL_REFERENCE`	Both	External reference
`REGISTERED_NAME`	Organization	Registered name
`ALTERNATE_NAME`	Organization	Alternate name
`REGISTRATION_NUMBER`	Organization	Registration number

Audit Enums

AuditEvent-Type

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/AuditEvent-Type

Value	Description
`CUSTOMER_SETUP`	Customer setup
`CUSTOMER_UPDATE`	Customer update
`ENTITY_CREATE`	Entity creation
`ENTITY_LOOKUP`	Entity lookup
`ENTITY_PURGE`	Entity deletion
`ENTITY_RESULT_UPDATE`	Manual result update
`ENTITY_RESULT_INVALIDATE`	Result invalidation
`ENTITY_UPDATE`	Entity update
`GENERATE_REPORT`	Report generation
`LEGACY_AUDIT`	V1 audit event
`MATCHLIST_ENTRY`	Matchlist entry operation
`PORTAL_ACTION`	Portal event
`RISK_OVERRIDE`	Risk override
`SERVICE_PROFILE_CREATE`	Service profile creation
`SERVICE_PROFILE_UPDATE`	Service profile update
`SERVICE_PROFILE_STATE_CHANGE`	Service profile state change
`WORKFLOW_EVENT`	Generic workflow event
`WORKFLOW_COMPLETE`	Workflow completion
`WORKFLOW_RISK_CHANGE`	Workflow risk change
`WORKFLOW_STATUS_CHANGE`	Workflow status change
`OTHER`	Other event type

AuditEvent-Channel

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/AuditEvent-Channel

Value	Description
`API`	API channel
`PORTAL`	Portal channel
`ONESDK`	OneSDK channel
`SYSTEM`	System channel

AuditEvent-Status

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/AuditEvent-Status

Value	Description
`SUCCESS`	Event succeeded
`ERROR`	Event encountered error
`INFO`	Informational event

Object Type Enum

Object-Type

Source: v2-openapi.json → #/components/schemas/Object-Type

Value	Description
`ADDRESS`	Address object
`NAME`	Name object
`PHONE_NUMBER`	Phone number object
`EMAIL`	Email object
`DATE_OF_BIRTH`	Date of birth object
`WEBSITE`	Website object
`SHAREHOLDER`	Shareholder object
`OFFICIAL`	Official object
`UBO`	Ultimate Beneficial Owner
`REGISTRATION`	Registration object
`SHAREHOLDING`	Shareholding object
`SHARECAPITAL`	Share capital object
`DOCUMENT`	Document object
`DOCUMENT_ATTACHMENT`	Document attachment object
`RESULT_PROCESS`	Process result object
`RESULT_STEP`	Step result object
`RESULT_WORKFLOW`	Workflow result object
`SERVICE_PROFILE`	Service profile object
`AUDIT_EVENT`	Audit event object
`EXTERNAL_REFERENCE`	External reference object
`RISK_ASSESSMENT`	Risk assessment object
`MATCHLIST`	Matchlist object

Workflow-Execution-ObjectTypeEnum

Source: v2-openapi.json → #/components/schemas/Workflow-Execution-ObjectTypeEnum

Value	Description
`NAME`	Name object
`ADDRESS`	Address object
`DATE_OF_BIRTH`	Date of birth object
`ORGANIZATION`	Organization object
`DOCUMENT`	Document object
`EMAIL_ADDRESS`	Email address object
`PHONE_NUMBER`	Phone number object
`DEVICE`	Device object
`INDIVIDUAL`	Individual object

Fraud & Activity Enums

Fraud-Check-Types

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Fraud-Check-Types

Value	Description
`DEVICE`	Device fraud check
`IP`	IP address fraud check
`EMAIL_ADDRESS`	Email address fraud check
`PHONE_NUMBER`	Phone number fraud check

Likelihood

Source: v2-openapi.json → #/components/schemas/Likelihood

Value	Description
`LOW`	Low likelihood
`MEDIUM`	Medium likelihood
`HIGH`	High likelihood
`VERY_HIGH`	Very high likelihood
`UNKNOWN`	Unknown likelihood

Supplementary Data Type Enums

Supplementary-Data-Base Type

Source: v2-openapi.json → #/components/schemas/Supplementary-Data-Base → type

Value	Description
`AML`	Anti-Money Laundering data
`KYC_ADDRESS`	KYC address data
`KYC_DOB`	KYC date of birth data
`KYC_GENDER`	KYC gender data
`KYC_NAME`	KYC name data
`ID`	Identity document data
`VISA`	Visa data
`NAME_VALIDATION`	Name validation data
`KYB_ORGANIZATION`	KYB organization data
`MATCHLIST`	Matchlist data
`DUPLICATE`	Duplicate data
`FRAUD_DEVICE`	Fraud device data
`FRAUD_EMAIL_ADDRESS`	Fraud email address data
`FRAUD_PHONE_NUMBER`	Fraud phone number data
`FRAUD_IP_ADDRESS`	Fraud IP address data
`FRAUD_LOOKUP`	Fraud lookup data
`ACTIVITY_AML`	Activity AML data
`ACTIVITY_DEVICE`	Activity device data
`ACTIVITY_FRAUD`	Activity fraud data

Query Parameter Enums

Level Query Parameter

Source: v2-openapi.json → #/components/parameters/levelQuery

Value	Description
`id`	Return just an ID
`meta`	Return metadata only, no links or base64
`base64`	Return metadata and data in base64 format

Level Query Parameter (No ID)

Source: v2-openapi.json → #/components/parameters/levelNoIdQuery

Value	Description
`meta`	Return metadata only, no links or base64
`base64`	Return metadata and images as base64

X-Frankie-Background

Source: v2-openapi.json → #/components/parameters/X-Frankie-Background

Value	Description
`0`	Synchronous request (wait for completion)
`1`	Asynchronous request (return 202, run in background)

Sort Order

Source: v2-openapi.json → #/components/parameters/sort

Value	Description
`asc`	Ascending order
`desc`	Descending order

External Reference Enums

External-Reference Type

Source: v2-openapi.json → #/components/schemas/External-Reference → type

Value	Description
`SYSTEM`	System reference
`CUSTOMER`	Customer reference
`OTHER`	Other reference type

Name Enums

Individual-Name-Alternate Type

Source: v2-openapi.json → #/components/schemas/Individual-Name-Alternate → type

Value	Description
`OTHER`	Other name type
`ALIAS`	Alias name
`PREVIOUS`	Previous name

Supplementary Data Document Type Enums

Document-Supplementary-Data Type

Source: v2-openapi.json → #/components/schemas/Document-Supplementary-Data-Base → type

Value	Description
`NATIONAL_HEALTH_ID`	National health ID supplementary data
`BIRTH_CERT`	Birth certificate supplementary data
`NATIONAL_ID`	National ID supplementary data
`CITIZENSHIP`	Citizenship supplementary data
`PASSPORT`	Passport supplementary data
`MARRIAGE_CERT`	Marriage certificate supplementary data

Visa Enums

Visa Holder Type

Source: v2-openapi.json → #/components/schemas/Supplementary-Data-Visa → holderType

Value	Description
`PRIMARY`	Primary visa holder
`SECONDARY`	Secondary holder (spouse/partner/family)

Name Validation Enums

Name Match Order

Source: v2-openapi.json → #/components/schemas/Workflow-Step-Summary-NameValidation → nameMatchOrder

Value	Description
`FGO`	Family, Given, Other names
`OFG`	Other, Family, Given names
`GOF`	Given, Other, Family names
`FOG`	Family, Other, Given names
`GFO`	Given, Family, Other names
`OGF`	Other, Given, Family names
`FG`	Family, Given names
`FO`	Family, Other names
`GF`	Given, Family names
`OF`	Other, Family names

Result Reference Type

Result-Reference-Type

Source: v2-openapi.json → #/components/schemas/Result-Reference-Type

Value	Description
`URL`	URL reference
`REFERENCE`	Reference identifier

Workflow Include Query

Include Query Parameter

Source: v2-openapi.json → #/components/parameters/includeQuery

Value	Description
`workflowDefinition`	Include workflow definition in response

Workflow Execution Scope

Workflow-Execution-ScopeEnum

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Workflow-Execution-ScopeEnum

Value	Description
`LAST`	Apply filters only to most recent workflow execution
`ANY`	Search across all workflow executions

Status Override Filter

Status-Override-Type-Filter

Source: v2-fc-core-bundled_generated.yaml → #/components/schemas/Status-Override-Type-Filter

Value	Description
`ONLY_OVERRIDDEN`	Only profiles with manually overridden statuses
`EXCLUDE_OVERRIDDEN`	Exclude profiles with overridden statuses
`ALL`	Both with and without overridden statuses

Notes

Enum Coverage

All enums documented above are verified from the OpenAPI specifications:

v2-openapi.json (KYC V2 API)
v2-fc-core-bundled_generated.yaml (Core V2 API)

Missing from Spec

The following risk factor handlers mentioned in use case pages are NOT IN SPEC:

entity_age
entity_type
jurisdiction_lookup
document_type_lookup
num_sanctions
pep_level_lookup
pep_origin_lookup
has_adverse_media
on_watchlist
idv_document_result
idv_facial_comparison_result
idv_ocr_comparison_result
fraud_email
fraud_phone_number
fraud_ip_address
fraud_device
fraud_count_session
unresolved_duplicates
on_matchlist_internal
workflow_attempts_counter

These handlers appear to be internal risk engine configuration values not exposed in the public API schema.

Introduction

KYC V2 API

Transaction and Activity Monitoring V2 API

KYB V2 API

Core V2 API

Documentation Index

​Entity & Profile Enums

​Entity-Type

​Service-Profile-State

​Workflow Execution Enums

​Workflow-Execution-ResultEnum

​Workflow-Execution-StateEnum

​Workflow-LifecyclePhaseEnum

​Workflow-Step-Type

​Workflow-Step-ResultEnum

​Process Result Enums

​Process-ResultEnum

​Process-Result-StateEnum

​Process-Result-System-StatusEnum

​Process-Result-ClassEnum

​Process-Result-Manual-StatusEnum-AML

​Process-Result-Manual-StatusEnum-KYC

​Process-Result-Manual-StatusEnum-IDV

​Process-Result-Manual-StatusEnum-Duplicate

​Process-Result-Manual-StatusEnum-Matchlist

​Process-Result-Manual-StatusEnum-Fraud

​Risk Enums

​Risk-Level

​Risk-Factor-Status

​Document Enums

​Document-Type

​Document-Class

​Document-Attachment-Side

​Document-Attachment-Retrieval-Status

​Individual Entity Enums

​Address-TypeEnum

​Address-StatusEnum

​GenderEnum

​Date-Type

​Contact Information Enums

​Phone Number Type

​Email Type

​Consent Enums

​Consent-Type-Param

​Workflow Issue Enums

​Workflow-Issue-Category

​Workflow-Issue-Type

​Workflow-Issue-Severity

​Monitoring & Subscription Enums

​Monitoring-Type / Subscription-Type

​Subscription-Status

​IDV (Identity Verification) Enums

​IDV OCR Status

​IDV Process Status

​Supplementary-Data-IDV-OCR-Comparison-Enum-Comparison-Source

​Matchlist Enums

​Matchlist-Action

​Matchlist-State

​Matchlist-Entry-State

​Matchlist-Entry-Attribute-Type

​Search Enums

​Search-Type

​Search-Field

​Audit Enums

​AuditEvent-Type

​AuditEvent-Channel

​AuditEvent-Status

​Object Type Enum

​Object-Type

​Workflow-Execution-ObjectTypeEnum

​Fraud & Activity Enums

​Fraud-Check-Types

​Likelihood

​Supplementary Data Type Enums

​Supplementary-Data-Base Type

​Query Parameter Enums

​Level Query Parameter

​Level Query Parameter (No ID)

​X-Frankie-Background

​Sort Order