Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/frankieone-idv-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Core V2 Audit IDV API
version: 2.0.0
description: This is the APIs for V2 Core. It allows you to do common operations, such as read audit entries or get workflow lists.
contact:
name: FrankieOne
url: https://www.frankieone.com/
email: help@frankieone.com
servers:
- url: https://api.uat.frankie.one
security:
- Api-Key: []
tags:
- name: IDV
description: Get a token and/or upload documents to initiate an IDV process
paths:
/v2/individuals/{entityId}/actions/idv/token:
parameters:
- $ref: '#/components/parameters/entityId'
post:
summary: Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated, this is to be called before starting the IDV or OCR process.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IDV-Token-Request'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IDV-Token-Response'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid EntityId:
value:
errorCode: API-0400,
errorMsg: 'Multiple Errors: See Issues list'
details:
- issue: 'entityId in path must be of type uuid: "test"'
issueLocation: VALIDATE-entityId
requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid authentication:
value:
errorCode: AUTH-0002,
errorMsg: Unauthorized
details:
- issue: Invalid Authentication provided. Access denied.
issueLocation: request
requestId: 00000000S6MNG7624K2TDXT1E3
No Api-Key:
value:
errorCode: AUTH-0401
errorMsg: Unauthorized
details:
- issue: No api key provided. Access denied.
issueLocation: request
requestId: 00000001S6MNG7624K2TDXT1E3
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: getIDVToken
description: Get an IDV Token for the given individual.
parameters:
- $ref: '#/components/parameters/Api-Key'
- $ref: '#/components/parameters/X-Frankie-CustomerID'
- $ref: '#/components/parameters/X-Frankie-CustomerChildID'
- $ref: '#/components/parameters/X-Frankie-Channel'
tags:
- IDV
security:
- Api-Key: []
- jwt:
- kyc:api
/v2/individuals/{entityId}/actions/idv/ocr:
parameters:
- $ref: '#/components/parameters/entityId'
post:
summary: Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IDV-OCR-Request'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IDV-OCR-Response'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid EntityId:
value:
errorCode: API-0400,
errorMsg: 'Multiple Errors: See Issues list'
details:
- issue: 'entityId in path must be of type uuid: "test"'
issueLocation: VALIDATE-entityId
requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid authentication:
value:
errorCode: AUTH-0002,
errorMsg: Unauthorized
details:
- issue: Invalid Authentication provided. Access denied.
issueLocation: request
requestId: 00000000S6MNG7624K2TDXT1E3
No Api-Key:
value:
errorCode: AUTH-0401
errorMsg: Unauthorized
details:
- issue: No api key provided. Access denied.
issueLocation: request
requestId: 00000001S6MNG7624K2TDXT1E3
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: processIDVOCR
description: Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results if successful. Status will be COMPLETE_OCR if OCR was successful and no further images are required. The image can be uploaded or captured via a vendor SDK after calling get IDV token, or can be submitted directly as a fileData.
parameters:
- $ref: '#/components/parameters/Api-Key'
- $ref: '#/components/parameters/X-Frankie-CustomerID'
- $ref: '#/components/parameters/X-Frankie-CustomerChildID'
- $ref: '#/components/parameters/X-Frankie-Channel'
tags:
- IDV
security:
- Api-Key: []
- jwt:
- kyc:api
/v2/individuals/{entityId}/actions/idv/process:
parameters:
- $ref: '#/components/parameters/entityId'
post:
summary: At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IDV-InitProcess-Request'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IDV-InitProcess-Response'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid EntityId:
value:
errorCode: API-0400,
errorMsg: 'Multiple Errors: See Issues list'
details:
- issue: 'entityId in path must be of type uuid: "test"'
issueLocation: VALIDATE-entityId
requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Invalid authentication:
value:
errorCode: AUTH-0002,
errorMsg: Unauthorized
details:
- issue: Invalid Authentication provided. Access denied.
issueLocation: request
requestId: 00000000S6MNG7624K2TDXT1E3
No Api-Key:
value:
errorCode: AUTH-0401
errorMsg: Unauthorized
details:
- issue: No api key provided. Access denied.
issueLocation: request
requestId: 00000001S6MNG7624K2TDXT1E3
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'502':
description: Bad Gateway
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: initBiometrics
description: "At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider\n that check is ready to analyse and check. If this call is successful, an entity\nis populated with with any details supplied if it doesn't not already have a name."
parameters:
- $ref: '#/components/parameters/Api-Key'
- $ref: '#/components/parameters/X-Frankie-CustomerID'
- $ref: '#/components/parameters/X-Frankie-CustomerChildID'
- $ref: '#/components/parameters/X-Frankie-Channel'
tags:
- IDV
security:
- Api-Key: []
- jwt:
- kyc:api
components:
schemas:
Supplementary-Data-KYC-DoB-MatchStrengths:
type: object
properties:
fullDateOfBirth:
type: integer
format: int32
minimum: 0
maximum: 100
year:
type: integer
format: int32
minimum: 0
maximum: 100
month:
type: integer
format: int32
minimum: 0
maximum: 100
day:
type: integer
format: int32
minimum: 0
maximum: 100
Date:
type: object
allOf:
- $ref: '#/components/schemas/Date-Base'
- type: object
properties:
normalized:
type: string
format: date
description: Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field.
example: '1990-03-31'
readOnly: true
Address-TypeEnum:
type: string
default: OTHER
enum:
- OTHER
- RESIDENTIAL
- BUSINESS
- POSTAL
- REGISTERED_OFFICE
- PLACE_OF_BUSINESS
- OFFICIAL_CORRESPONDANCE
- PLACE_OF_BIRTH
- OFFICE_LOCALITY
Individual-Name:
type: object
required:
- familyName
x-examples:
Example 1:
givenName: John
middleName: Jacob
familyName: Smith
properties:
nameId:
type: string
example: 87654321-4321-4321-4321-210987654321
description: Include the nameId of an existing name for this individual to modify it
readOnly: true
language:
type: string
example: eng
description: The ISO-639-3 standard code that best represents the language and character set of the individual's name
default: eng
givenName:
type: string
example: John
description: First name or given name
middleName:
type: string
example: R
description: Middle name(s) or middle initial(s)
familyName:
type: string
example: Doe
description: Last name, family name, or surname.
otherName:
type: string
example: null
description: Another name that this person may be known as, e.g., "Bob" as an alternative to "Robert".
prefix:
type: string
example: Dr.
description: Letters or words that come before an individual's full name (e.g., title or honorific).
suffix:
type: string
example: Jr.
description: Letters or words that come after an individual's full name (e.g., generational suffix).
sourceId:
type: string
example: 87654321-4321-4321-4321-210987654322
description: The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map
readOnly: true
displayName:
type: string
example: John Doe
description: Long format of the individual's full name, including any prefix, suffix, middle, or other names. Best used when the proper structure of the individual's name is unknown.
Supplementary-Data-KYB-Organization:
type: object
description: 'Defines OQRO (Ownership Query Result Object) at various stages in the KYB (Know Your Business) flow.
The ''oqro'' property temporarily stores the V1 OQRO and will be used until the V2 OQRO is defined.
'
allOf:
- $ref: '#/components/schemas/Supplementary-Data-Base'
- type: object
properties:
organization:
description: 'V2 OQRO; to be defined in the future.
'
properties:
entityId:
$ref: '#/components/schemas/Entity-ID'
entityType:
$ref: '#/components/schemas/Entity-Type'
Consent:
type: object
properties:
type:
type: string
description: The type of consent given by an entity
example: UNDER18
enum:
- GENERAL
- DOCS
- CREDITHEADER
- UNDER18
- PAYROLL
- INSURANCE
- SUPERANNUATION
schemaVersion:
type: integer
readOnly: true
sourceId:
type: string
description: The source from which specific information was obtained. This is a link to an informationSource object in the informationSources map.
example: 93da15f64-5717-4562-b3fc-2c963f6663fe
readOnly: true
Document-Attachment-Type:
type: string
description: "General types of valid document attachments.\n - \"PHOTO\": Any photo.\n - \"VIDEO\": Any video.\n - \"AUDIO\": Any audio.\n - \"PDF\": PDF or PS file (may contain text, images, or both).\n - \"DOC\": Word document, RTF, etc.\n - \"ZIP\": Any compressed file(s)."
GenderEnum:
type: string
enum:
- MALE
- FEMALE
- NON_BINARY
- OTHER
- UNSPECIFIED
IDV-Token-Response:
type: object
description: IDV Token Response, contains the token and it's expiry, and any vendor specific parameters.
properties:
applicantId:
description: The ID of the applicant attached to this check.
type: string
country:
description: Country code to check for. Must be a ISO-3166 alpha-3 code entry.
example: AUS
type: string
documentType:
description: Document type that will be used for the check.
example: DRIVER_LICENCE
type: string
provider:
description: Underlying provider, used for selecting the correct SDK if not using SmartUI.
example: OCRLabs
type: string
smsSent:
description: Has a sms to the user already been sent as part of the token request
example: true
type: boolean
token:
description: Tokens are only valid for a limited time.
example: 41cf9401f0f889616bef
type: string
tokenExpiry:
description: The time at which the provided token will expire.
type: string
format: date-time
example: '2020-01-01T00:00:00.000Z'
vendorParameters:
description: Vendor specific parameters, used for passing through additional parameters from the vendor to instantiate the SDK.
additionalProperties:
type: string
example:
tokenURL: example1.com
type: object
requestId:
$ref: '#/components/schemas/Request-ID'
Supplementary-Data-Matchlist:
type: object
description: 'Each match against a matchlist entry generates a PRO (Process Result Object), and this object describes the details of the matched entry.
'
allOf:
- $ref: '#/components/schemas/Supplementary-Data-Base'
- $ref: '#/components/schemas/Matchlist-Entry-Base'
- type: object
properties:
matchlistId:
type: string
format: uuid
description: Unique identifier for the matchlist.
matchlistName:
type: string
description: Unique name of the matchlist.
matchlistAction:
$ref: '#/components/schemas/Matchlist-Action'
confidence:
$ref: '#/components/schemas/Search-Confidence'
matchedFields:
type: array
items:
$ref: '#/components/schemas/Supplementary-Data-Matchlist-Field'
Attribute:
type: object
required:
- type
- value
properties:
type:
description: The attribute type.
type: string
maxLength: 64
value:
description: The value assigned to the attribute.
type: string
Device-Indicators:
type: object
properties:
riskScore:
type: integer
description: Risk score as determine by the device checking service
riskLevel:
$ref: '#/components/schemas/Risk-Level'
behaviorBiometrics:
$ref: '#/components/schemas/Behavior-Biometrics'
isRat:
type: boolean
description: Was the device user determined to be a rat?
isSupported:
type: boolean
description: Was the device supported or not?
isEmulated:
type: boolean
description: Was the device determined to be real or emulated?
isRooted:
type: boolean
description: Was the device determined to be rooted?
reputation:
type: string
description: The reputation of the device
vpnLikelihood:
$ref: '#/components/schemas/Likelihood'
proxyLikelihood:
$ref: '#/components/schemas/Likelihood'
botLikelihood:
$ref: '#/components/schemas/Likelihood'
Object-Type:
description: The type of object being annotated.
type: string
enum:
- ADDRESS
- NAME
- PHONE_NUMBER
- EMAIL
- DATE_OF_BIRTH
- WEBSITE
- SHAREHOLDER
- OFFICIAL
- UBO
- REGISTRATION
- SHAREHOLDING
- SHARECAPITAL
- DOCUMENT
- DOCUMENT_ATTACHMENT
- RESULT_PROCESS
- RESULT_STEP
- RESULT_WORKFLOW
- SERVICE_PROFILE
- AUDIT_EVENT
- EXTERNAL_REFERENCE
- RISK_ASSESSMENT
- MATCHLIST
Supplementary-Data-Fraud-IP-Address-Data:
type: object
description: 'Defines the details of a single fraud check for IP address related data.
'
properties:
deviceId:
$ref: '#/components/schemas/Device-ID'
ipAddressInformation:
$ref: '#/components/schemas/IP-Information'
session:
$ref: '#/components/schemas/Session-Data'
indicators:
type: array
items:
$ref: '#/components/schemas/Supplementary-Data-Activity-Result-Detail-Indicator'
riskLevel:
$ref: '#/components/schemas/Risk-Level'
reference:
$ref: '#/components/schemas/Result-Reference'
Supplementary-Data-Activity-Result-Detail-Indicator:
type: object
properties:
indicatorId:
$ref: '#/components/schemas/Indicator-ID'
name:
type: string
value:
type: string
score:
type: string
rules:
type: array
items:
$ref: '#/components/schemas/Supplementary-Data-Activity-Result-Detail-Rule'
Supplementary-Data-IDV-OCR:
type: object
description: 'Result of a document OCR comparison. This object represents the comparison between scanned data (via OCR) and updated or alternately supplied results.
For the resultMap keys, use the keys defined in the enum: SupplementaryDataIDVEnumDataOCR.
'
allOf:
- $ref: '#/components/schemas/Supplementary-Data-IDV-Base'
- type: object
properties:
scannedDocumentId:
type: string
format: uuid
description: 'The documentId of the ID document on which OCR extraction was performed.
'
scannedAttachmentFrontId:
type: string
format: uuid
description: 'The attachmentId of the front image of the ID document used for OCR extraction.
'
scannedAttachmentBackId:
type: string
format: uuid
description: 'The attachmentId of the back image of the ID document used for OCR extraction, if a back image was provided.
'
Supplementary-Data-Duplicate-MatchField:
type: object
description: 'Provides details of a match between entities, the objects they represent, and the match strength.
'
properties:
objectType:
$ref: '#/components/schemas/Object-Type'
duplicateObjectId:
type: string
format: uuid
description: The ID of the object that was found to be a duplicate.
objectId:
type: string
format: uuid
description: The ID of the object that originated the match.
matchStrength:
$ref: '#/components/schemas/Supplementary-Data-Base-MatchStrength'
Supplementary-Data-Activity-Result-Detail-Rule:
type: object
properties:
ruleId:
$ref: '#/components/schemas/Rule-ID'
reference:
type: string
name:
type: string
description:
type: string
isActive:
type: boolean
Document-Type:
type: string
enum:
- OTHER
- DRIVERS_LICENSE
- PASSPORT
- VISA
- IMMIGRATION
- NATIONAL_ID
- TAX_ID
- NATIONAL_HEALTH_ID
- CONCESSION
- HEALTH_CONCESSION
- PENSION
- MILITARY_ID
- BIRTH_CERT
- CITIZENSHIP
- MARRIAGE_CERT
- DEATH_CERT
- NAME_CHANGE
- UTILITY_BILL
- BANK_STATEMENT
- BANK_ACCOUNT
- INTENT_PROOF
- ATTESTATION
- SELF_IMAGE
- DEVICE
- VEHICLE_REGISTRATION
- PROOF_OF_ADDRESS
- HOUSE_REGISTRATION
- YELLOW_HOUSE_REGISTRATION
- WORK_PERMIT
- EMPLOYMENT_CERTIFICATE
- NOTARY_PUBLIC_ID
- EXTERNAL_ADMIN
- CHARGES
- PRE_ASIC
- ANNUAL_RETURN
- REPORT
- TRUST_DEED
- PARTNERSHIP_AGREEMENT
- ADMIN_CHANGE
- COMPANY_REPORT
- CHECK_RESULTS
- AVIATION_SECURITY_ID
- MARITIME_SECURITY_ID
description: "Valid document ID types.\n\n - \"OTHER\": Generic document type. Unspecified.\n - \"DRIVERS_LICENSE\": Driver's license.\n - \"PASSPORT\": Passport.\n - \"VISA\": Visa document (not Visa payment card).\n - \"IMMIGRATION\": Immigration card.\n - \"NATIONAL_ID\": Any national ID card.\n - \"TAX_ID\": Any national tax identifier.\n - \"NATIONAL_HEALTH_ID\": Any national health program ID card (e.g., Medicare, NHS).\n - \"CONCESSION\": State-issued concession card.\n - \"HEALTH_CONCESSION\": State-issued health-specific concession card.\n - \"PENSION\": State-issued pension ID.\n - \"MILITARY_ID\": Military ID.\n - \"BIRTH_CERT\": Birth certificate.\n - \"CITIZENSHIP\": Citizenship certificate.\n - \"MARRIAGE_CERT\": Marriage certificate.\n - \"DEATH_CERT\": Death certificate.\n - \"NAME_CHANGE\": Name change confirmation.\n - \"UTILITY_BILL\": Regulated utility bill, such as electricity, gas, etc.\n - \"BANK_STATEMENT\": Bank/card statement.\n - \"BANK_ACCOUNT\": Bank account.\n - \"INTENT_PROOF\": Proof of intent, generally a photo/video or a scanned letter.\n - \"ATTESTATION\": Document of attestation (e.g., Statutory Declaration).\n\n NOTE: These cannot be used as a supporting document:\n - \"SELF_IMAGE\": A \"selfie\" used for comparisons.\n - \"DEVICE\": Device ID.\n - \"VEHICLE_REGISTRATION\": Vehicle registration number.\n - \"PROOF_OF_ADDRESS\": Any document that provides proof of address.\n - \"HOUSE_REGISTRATION\": House registration document.\n - \"YELLOW_HOUSE_REGISTRATION\": Yellow House Registration Thor Ror 13.\n - \"WORK_PERMIT\": Work permit.\n - \"EMPLOYMENT_CERTIFICATE\": Certificate of employment.\n - \"NOTARY_PUBLIC_ID\": Notary Public Identification.\n\n Business-related documentation:\n\n - \"EXTERNAL_ADMIN\": Details of appointed administrator.\n - \"CHARGES\": Details of any charges laid against a company or director.\n - \"PRE_ASIC\": Any documents that are Pre-ASIC.\n - \"ANNUAL_RETURN\": Details of a company's annual return.\n - \"REPORT\": Frankie-generated report.\n - \"TRUST_DEED\": Corporate trust deed.\n - \"PARTNERSHIP_AGREEMENT\": Partnership agreement documents.\n - \"ADMIN_CHANGE\": Change of administrator.\n - \"COMPANY_REPORT\": Registry-filed company reports.\n\n Special document types:\n\n - \"CHECK_RESULTS\": Special document type for specifying results of checks completed other than through Frankie.\n - \"AVIATION_SECURITY_ID\": Aviation Security Identification Card.\n - \"MARITIME_SECURITY_ID\": Maritime Security Identification Card."
Information-Source:
type: object
properties:
sourceId:
type: string
description: 'As sources are added to an entity, they''re assigned a unique identifier to assist with modification and reference.
To modify a source, include the sourceId in an update request call.'
type:
description: The type of source information e.g. "ID number"
type: string
example: ID number
deprecated: true
source:
description: The source of information like document number, website, etc.
type: string
example: Client
description:
description: The type or details of the source of information.
type: string
example: ''
provider:
description: The provider of the information, e.g., Equifax.
type: string
example: equifax-au
providerReference:
description: Reference linking to the provider for this information.
type: string
example: ''
createdAt:
type: string
format: date-time
description: The date and time this information was first created in the system.
example: '2024-01-15T02:18:11.365Z'
requestedAt:
type: string
format: date-time
description: The date and time FrankieOne requested this information from the external source provider.
example: '2024-01-15T02:18:11.365Z'
generatedAt:
type: string
format: date-time
description: The date and time FrankieOne generated this information, if applicable.
example: '2024-01-15T02:18:11.365Z'
retrievedAt:
type: string
format: date-time
description: The date and time FrankieOne retrieved this information from the external source provider.
example: '2024-01-15T02:18:11.365Z'
updatedAt:
type: string
format: date-time
description: The date and time this information was last updated in the system.
example: '2024-01-15T02:18:11.365Z'
isAuthoritative:
type: boolean
description: Indicates whether this information is from an authoritative source, e.g., a company registry.
example: false
isManual:
description: Indicates whether this information was added manually by the client rather than by a system or source provider.
type: boolean
example: true
deprecated: true
readOnly: true
Request-ID:
type: string
example: 01HN9XHZN6MGXM9JXG50K59Q85
description: The unique request identifier for the API call made.
Supplementary-Data-AML-MatchData:
type: object
required:
- spReferenceId
- name
description: 'Contains information about this specific matched entity.
'
properties:
strength:
type: number
format: float
description: The match strength as determined by the service provider.
spReferenceId:
type: string
description: 'The internal identifier assigned by the service provider for the matched individual or business.
'
name:
type: string
description: 'The name matched by the service provider.
'
givenName:
type: string
description: 'The given name matched by the service provider (optional).
'
otherName:
type: string
description: 'The middle or other name(s) matched by the service provider (optional).
'
familyName:
type: string
description: 'The family name matched by the service provider (optional).
'
date:
type: string
description: 'The date matched in the system, formatted as provided by the service provider. May be only a year.
'
address:
type: string
description: 'The address matched by the service provider (optional).
'
countries:
type: array
items:
$ref: '#/components/schemas/Supplementary-Data-AML-MatchData-Country'
nationalId:
$ref: '#/components/schemas/Supplementary-Data-AML-MatchData-NationalId'
imageUrl:
type: string
format: uri
description: A URL to a displayable image of the matched individual or company logo.
isDeceased:
type: boolean
description: Indicates if this match is to a deceased individual.
isAlias:
type: boolean
description: Indicates if this match is an alias of the searched individual or organization.
isRelated:
type: boolean
description: Indicates if this match is a related party of the searched individual or organization.
Individual-Name-Alternate:
type: object
required:
- familyName
x-examples:
Example 1:
givenName: John
middleName: Jacob
familyName: Smith
properties:
nameId:
type: string
example: 87654321-4321-4321-4321-210987654321
description: Include the nameId of an existing name for this individual to modify it.
language:
type: string
example: eng
description: The ISO-639-3 standard code that best represents the language and character set of the individual's name.
default: eng
givenName:
type: string
# --- truncated at 32 KB (150 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-idv-api-openapi.yml