--- title: "Create an individual entity" method: POST path: "/v2/individuals" tags: ["Individual Entities"] --- # Create an individual entity `POST /v2/individuals` Creates an Individual entity object which can be used to store data about an individual. You can optionally include documents, attachments, references etc. to the entity. Information stored in an entity object can be used to verify the individual against external data sources for the purposes of eKYC, or in other verifications supported by FrankieOne. ## Headers - `api_key` string, required - `X-Frankie-CustomerID` string, required - `X-Frankie-CustomerChildID` string - `X-Frankie-Channel` string - `X-Frankie-Username` string ## Request body - IndividualsCreate - `individual` Individual - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `entityType` 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN' — The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN". - `createdAt` string, date-time - `schemaVersion` integer — The schema version of this entity. - `addresses` Address[] — A list of all address information associated with the entity. - `addressId` string — As addresses are added to an entity, they are assigned an ID to assist with tracking. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `type` 'OTHER' | 'RESIDENTIAL' | 'BUSINESS' | 'POSTAL' | 'REGISTERED_OFFICE' | 'PLACE_OF_BUSINESS' | 'OFFICIAL_CORRESPONDANCE' | 'PLACE_OF_BIRTH' | 'OFFICE_LOCALITY' - `typeDescription` string — Description for the type or the address type as fetched from an authoritative source like a company registry. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `longForm` string — In some cases, the address will need to be supplied in "long form", such as when it is determined from a document scan, or is unparsable in some way. The service will attempt to convert it to its constituent parts where possible. WARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You have been warned. Failure to break down or disambiguate the address will result in an error. - `unitNumber` string — Unit/Apartment/Flat/Suite/etc. number - `buildingName` string — The name of the building, apartment block, condominium, etc. - `streetName` string — The name of the street. This field should ideally contain only the street name, without the street number or street type. In some cases, especially when auto-populated by external services (e.g., Google), it may include additional address components. For best results, keep the street name separate from the street number and street type. See https://apidocs.frankiefinancial.com/docs/working-with-addresses for more details. - `streetNumber` string — The number assigned to the property on the street. Typically a number, but can also be alphanumeric (e.g., 3A). - `streetType` string — The street type, such as Road, Street, Avenue, Circuit, etc. - `neighborhood` string — The neighborhood or suburb within the town or city. Use this only if you require both a suburb and a locality/town/city; otherwise, use the "locality" parameter. - `locality` string — The locality, town, village, suburb, or city. - `district` string — The district, region, county, province, or cantonment. - `subdivision` string — The administrative area, state, or sub-division. Use local abbreviations, such as VIC (Victoria) or TX (Texas). - `country` string, required — The ISO-3166-1 country code. You must use the alpha-3 country code (e.g., AUS, USA, IDR, KOR, etc). Conversion will be handled as needed. For more details, refer to: https://en.wikipedia.org/wiki/ISO_3166-1 - `postalCode` string — The postal code of the address. - `careOf` string — The individual or business name at this address, if different from the name of the entity to which this address belongs. - `status` 'CURRENT' | 'PREVIOUS' | 'FUTURE' - `unstructuredLongForm` string — Raw, unformatted address as provided by the source. Not normalized or standardized. - `phoneNumbers` PhoneNumber[] — A list of all phone numbers associated with the entity. - `phoneNumberId` string — As phone numbers are added to an entity, they are assigned an ID to assist with tracking. If you are adjusting phone numbers, you will need to include the ID to reference it correctly in the list. - `isPreferred` boolean — Indicates whether this is the individual's preferred phone number. - `type` 'OTHER' | 'WORK' | 'HOME' | 'MOBILE' | 'BUSINESS' | 'FAX' — The type of phone number. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `country` string — ISO-3166-1 alpha-3 country code. - `number` string — The phone number. - `linkedAddresses` object[] — If the phone number is attached to one or more addresses, the address IDs of those addresses will be present. - `addressId` string — The addressId of the linked address. - `unstructuredLongForm` string — Used to capture free-form phone numbers or to store numbers that could not be normalized. - `emailAddresses` Email[] — A list of all email addresses associated with the entity. - `emailAddressId` string — As email addresses are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify an email, include the emailId in an update request. - `type` 'OTHER' | 'WORK' | 'PERSONAL' | 'BUSINESS' — The type of email address, if known. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `email` string — The individual's email address. This email can be used to notify the individual of any verification requirements. - `isPreferred` boolean — Indicates whether this email address is the individual's preferred email. The preferred email will be used to send notifications at the client's request. - `linkedAddresses` object[] — If the email is attached to one or more addresses, the address IDs of those addresses will be present. - `addressId` string — The addressId of the linked address. - `customAttributes` CustomAttributes - `externalReferences` ExternalReference[] — A list of all external references associated with the entity. - `referenceId` string — As external references are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify an external reference, include the referenceId in an update request for the individual. - `type` 'SYSTEM' | 'CUSTOMER' | 'OTHER' - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `name` string, required — The name of the external reference. - `value` string, required — The value of the external reference. - `description` string — A summary of what this external reference is and what it is used for. - `documents` EntityDocuments - `REPORT` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `SUPPORTING` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `IDENTITY` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `OTHER` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `name` IndividualName - `nameId` string — Include the nameId of an existing name for this individual to modify it - `language` string — The ISO-639-3 standard code that best represents the language and character set of the individual's name - `givenName` string — First name or given name - `middleName` string — Middle name(s) or middle initial(s) - `familyName` string, required — Last name, family name, or surname. - `otherName` string — Another name that this person may be known as, e.g., "Bob" as an alternative to "Robert". - `prefix` string — Letters or words that come before an individual's full name (e.g., title or honorific). - `suffix` string — Letters or words that come after an individual's full name (e.g., generational suffix). - `sourceId` string — The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map - `displayName` string — 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. - `alternateNames` IndividualNameAlternate[] — Other names that are legally registered or otherwise recorded, differing from the individual's primary English name (e.g., "李小龍"). Non-English names may be created as a conversion from the original format to complete the verification process. - `nameId` string — Include the nameId of an existing name for this individual to modify it. - `language` string — The ISO-639-3 standard code that best represents the language and character set of the individual's name. - `givenName` string — First name or given name. - `middleName` string — Middle name(s) or middle initial(s). - `familyName` string, required — Last name, family name, or surname. - `otherName` string — Other names to be stored with the entity. - `prefix` string — Element or series of letters that precede the individual's full name (e.g., title or honorific). - `suffix` string — Element or series of letters that follow the individual's full name (e.g., generational suffix). - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `displayName` string — 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. - `type` 'OTHER' | 'ALIAS' | 'PREVIOUS' — Classification of the individual's name in relation to any of their alternative names. - `dateOfBirth` DateOfBirth - `dateOfBirthId` string — As dates of birth are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a date of birth, include the dateOfBirthId in an update request for the individual. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `alternateDatesOfBirth` DateOfBirthAlternate[] — Other dates that are registered or otherwise recorded, differing from the individual's primary Gregorian date of birth (e.g., Islamic dates like "29 Jumada Al-Akhirah 1445"). Non-Gregorian date formats will be maintained; however, additional Gregorian dates of birth may be created as a conversion from the original format to complete the verification process. - `dateOfBirthId` string — As dates of birth are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a date of birth, include the dateOfBirthId in an update request for the individual. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `gender` Gender - `genderId` string - `gender` 'MALE' | 'FEMALE' | 'NON_BINARY' | 'OTHER' | 'UNSPECIFIED' - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `placeOfBirth` AddressPlaceOfBirth — The country or address where the individual was born. - `addressId` string — As addresses are added to an entity, they are assigned an ID to assist with tracking. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `longForm` string — In some cases, the address will need to be supplied in "long form", such as when it is determined from a document scan, or is unparsable in some way. The service will attempt to convert it to its constituent parts where possible. WARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You have been warned. Failure to break down or disambiguate the address will result in an error. - `unstructuredLongForm` string — Raw, unformatted address as provided by the source. Not normalized or standardized. - `unitNumber` string — Unit/Apartment/Flat/Suite/etc. number - `buildingName` string — The name of the building, apartment block, condominium, etc. - `streetName` string — The name of the street. This field should ideally contain only the street name, without the street number or street type. In some cases, especially when auto-populated by external services (e.g., Google), it may include additional address components. For best results, keep the street name separate from the street number and street type. See https://apidocs.frankiefinancial.com/docs/working-with-addresses for more details. - `streetNumber` string — The number assigned to the property on the street. Typically a number, but can also be alphanumeric (e.g., 3A). - `streetType` string — The street type, such as Road, Street, Avenue, Circuit, etc. - `neighborhood` string — The neighborhood or suburb within the town or city. Use this only if you require both a suburb and a locality/town/city; otherwise, use the "locality" parameter. - `locality` string — The locality, borough, town, village, or city. - `district` string — The district, region, county, province, or cantonment. - `subdivision` string — The ISO 3166-2 alphanumeric code of the administrative area/state/sub-division, minus the country code, e.g., VIC (Victoria) or TX (Texas). - `country` string, required — The ISO 3166-1 alphanumeric three-letter code of the country, e.g., AUS, USA, IDR, KOR, etc. For more details, refer to: https://en.wikipedia.org/wiki/ISO_3166-1 - `postalCode` string — The postal, zip, or pin code of the address. - `nationality` string — ISO-3166-1 alpha-3 code of the individual's legal membership or affiliation with a nation. - `consents` Consent[] — List of consent types that have been given for this entity. - `type` 'GENERAL' | 'DOCS' | 'CREDITHEADER' | 'UNDER18' | 'PAYROLL' | 'INSURANCE' | 'SUPERANNUATION' — The type of consent given by an entity - `schemaVersion` integer - `sourceId` string — The source from which specific information was obtained. This is a link to an informationSource object in the informationSources map. - `informationSources` object — Map of information sources used across the response. - `relationships` IndividualRelationships - `duplicates` Relationship[] — List of duplicates for this individual. To determine which entity was marked as a duplicate, refer to the entity state of the relevant duplicate or reconcile using the process results. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `entityType` 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN' — The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN". - `origin` RelationshipOrigin — Details about the process that originated the relationship. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `entityType` 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN' — The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN". - `processResultId` string — When a process result object is first created, it is assigned an ID. When updating the process result object, set the processResultID to the ID of the process result object you are referring to. - `createdAt` string, date-time — The date and time when the relationship origin record was created. - `serviceName` string - `workflowName` string - `comment` Comment - `commentId` string — Unique identifier for the comment. - `text` string — The text content of the comment. ## Response `201` Created - IndividualsEntityResponse - `individual` Individual - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `entityType` 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN' — The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN". - `createdAt` string, date-time - `schemaVersion` integer — The schema version of this entity. - `addresses` Address[] — A list of all address information associated with the entity. - `addressId` string — As addresses are added to an entity, they are assigned an ID to assist with tracking. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `type` 'OTHER' | 'RESIDENTIAL' | 'BUSINESS' | 'POSTAL' | 'REGISTERED_OFFICE' | 'PLACE_OF_BUSINESS' | 'OFFICIAL_CORRESPONDANCE' | 'PLACE_OF_BIRTH' | 'OFFICE_LOCALITY' - `typeDescription` string — Description for the type or the address type as fetched from an authoritative source like a company registry. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `longForm` string — In some cases, the address will need to be supplied in "long form", such as when it is determined from a document scan, or is unparsable in some way. The service will attempt to convert it to its constituent parts where possible. WARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You have been warned. Failure to break down or disambiguate the address will result in an error. - `unitNumber` string — Unit/Apartment/Flat/Suite/etc. number - `buildingName` string — The name of the building, apartment block, condominium, etc. - `streetName` string — The name of the street. This field should ideally contain only the street name, without the street number or street type. In some cases, especially when auto-populated by external services (e.g., Google), it may include additional address components. For best results, keep the street name separate from the street number and street type. See https://apidocs.frankiefinancial.com/docs/working-with-addresses for more details. - `streetNumber` string — The number assigned to the property on the street. Typically a number, but can also be alphanumeric (e.g., 3A). - `streetType` string — The street type, such as Road, Street, Avenue, Circuit, etc. - `neighborhood` string — The neighborhood or suburb within the town or city. Use this only if you require both a suburb and a locality/town/city; otherwise, use the "locality" parameter. - `locality` string — The locality, town, village, suburb, or city. - `district` string — The district, region, county, province, or cantonment. - `subdivision` string — The administrative area, state, or sub-division. Use local abbreviations, such as VIC (Victoria) or TX (Texas). - `country` string, required — The ISO-3166-1 country code. You must use the alpha-3 country code (e.g., AUS, USA, IDR, KOR, etc). Conversion will be handled as needed. For more details, refer to: https://en.wikipedia.org/wiki/ISO_3166-1 - `postalCode` string — The postal code of the address. - `careOf` string — The individual or business name at this address, if different from the name of the entity to which this address belongs. - `status` 'CURRENT' | 'PREVIOUS' | 'FUTURE' - `unstructuredLongForm` string — Raw, unformatted address as provided by the source. Not normalized or standardized. - `phoneNumbers` PhoneNumber[] — A list of all phone numbers associated with the entity. - `phoneNumberId` string — As phone numbers are added to an entity, they are assigned an ID to assist with tracking. If you are adjusting phone numbers, you will need to include the ID to reference it correctly in the list. - `isPreferred` boolean — Indicates whether this is the individual's preferred phone number. - `type` 'OTHER' | 'WORK' | 'HOME' | 'MOBILE' | 'BUSINESS' | 'FAX' — The type of phone number. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `country` string — ISO-3166-1 alpha-3 country code. - `number` string — The phone number. - `linkedAddresses` object[] — If the phone number is attached to one or more addresses, the address IDs of those addresses will be present. - `addressId` string — The addressId of the linked address. - `unstructuredLongForm` string — Used to capture free-form phone numbers or to store numbers that could not be normalized. - `emailAddresses` Email[] — A list of all email addresses associated with the entity. - `emailAddressId` string — As email addresses are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify an email, include the emailId in an update request. - `type` 'OTHER' | 'WORK' | 'PERSONAL' | 'BUSINESS' — The type of email address, if known. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `email` string — The individual's email address. This email can be used to notify the individual of any verification requirements. - `isPreferred` boolean — Indicates whether this email address is the individual's preferred email. The preferred email will be used to send notifications at the client's request. - `linkedAddresses` object[] — If the email is attached to one or more addresses, the address IDs of those addresses will be present. - `addressId` string — The addressId of the linked address. - `customAttributes` CustomAttributes - `externalReferences` ExternalReference[] — A list of all external references associated with the entity. - `referenceId` string — As external references are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify an external reference, include the referenceId in an update request for the individual. - `type` 'SYSTEM' | 'CUSTOMER' | 'OTHER' - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `name` string, required — The name of the external reference. - `value` string, required — The value of the external reference. - `description` string — A summary of what this external reference is and what it is used for. - `documents` EntityDocuments - `REPORT` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `SUPPORTING` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `IDENTITY` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `OTHER` DocumentInformation[] - `documentId` string, uuid — As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `expiryDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `issueDate` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `primaryIdentifier` string — The primary ID number of the document, e.g., the ID number on a driver licence. - `secondaryIdentifier` string — The secondary ID number of the document, e.g., the card number on a driver licence. - `type` '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', required — Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERS_LICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (not Visa payment card). - "IMMIGRATION": Immigration card. - "NATIONAL_ID": Any national ID card. - "TAX_ID": Any national tax identifier. - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g., Medicare, NHS). - "CONCESSION": State-issued concession card. - "HEALTH_CONCESSION": State-issued health-specific 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, such as electricity, gas, etc. - "BANK_STATEMENT": Bank/card statement. - "BANK_ACCOUNT": Bank account. - "INTENT_PROOF": Proof of intent, generally a photo/video or a scanned letter. - "ATTESTATION": Document of attestation (e.g., Statutory Declaration). NOTE: These cannot be used as a supporting document: - "SELF_IMAGE": A "selfie" used for comparisons. - "DEVICE": Device ID. - "VEHICLE_REGISTRATION": Vehicle registration number. - "PROOF_OF_ADDRESS": Any document that provides proof of address. - "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. Business-related documentation: - "EXTERNAL_ADMIN": Details of appointed administrator. - "CHARGES": Details of any charges laid against a company or director. - "PRE_ASIC": Any documents that are Pre-ASIC. - "ANNUAL_RETURN": Details of a company's 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. Special document types: - "CHECK_RESULTS": Special document type for specifying results of checks completed other than through Frankie. - "AVIATION_SECURITY_ID": Aviation Security Identification Card. - "MARITIME_SECURITY_ID": Maritime Security Identification Card. - `subtype` string — The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report). - `subdivision` string — The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., "VIC" for the Australian state of Victoria or "MA" for the US state of Massachusetts. - `country` string, required — The ISO 3166 alpha-3 country code where the document was issued, if relevant. For more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes - `createdAt` string, date-time — The date and time when the document record was created, in ISO 8601 format. - `updatedAt` string, date-time — The date and time when the document record was last updated, in ISO 8601 format. - `validFrom` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `validTo` Date - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `supplementaryData` union — Supplementary information relevant to a specific document or report type. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `reference` string — The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card). - `nameOnCardLine1` string — The individual's name as it appears on the card. - `nameOnCardLine2` string — If the individual's name spans more than one line, this is the part of the name that appears on line 2. - `nameOnCardLine3` string — If the individual's name spans more than two lines, this is the part of the name that appears on line 3. - `nameOnCardLine4` string — If the individual's name spans more than three lines, this is the part of the name that appears on line 4. - `middleNameOnCard` string — The individual's middle name or initial as it appears on the card. - object — Supplementary information relevant to a birth certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `registrationDate` string — The date the birth was registered. - `registrationDistrict` string — The district where the birth was registered. - `dateOfPrint` string — The date the birth certificate was printed. - `givenName` string — The given name as printed on the certificate. - `otherNames` string — Other name(s) as printed on the certificate. - `familyName` string — The family name as printed on the certificate. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original full name from the individual's home country national ID. - `paternalFamilyName` string — The individual's family name inherited from the father's side. - `maternalFamilyName` string — The individual's family name inherited from the mother's side. - object — Supplementary information relevant to a citizenship certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `acquisitionDate` string — The date citizenship was acquired. - `primaryCountry` string — The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code. - `secondaryCountry` string — The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code. - object — Supplementary data associated with a document. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `homeCountryFullName` string — The original name from the home country of passport. - object — Supplementary information relevant to a marriage certificate. - `type` 'NATIONAL_HEALTH_ID' | 'BIRTH_CERT' | 'NATIONAL_ID' | 'CITIZENSHIP' | 'PASSPORT' | 'MARRIAGE_CERT', required — The document type that defines the type of supplementary data returned. - `partner1GivenName` string — The given name of partner 1. - `partner1FamilyName` string — The family name of partner 1. - `partner1OtherName` string — The other name of partner 1. - `partner2GivenName` string — The given name of partner 2. - `partner2FamilyName` string — The family name of partner 2. - `partner2OtherName` string — The other name of partner 2. - `registrationDate` string — The date the marriage was registered. - `marriageDate` string — The date the marriage was held. - `dateOfPrint` string — The date the birth certificate was printed. - `customAttributes` CustomAttributes - `attachments` DocumentAttachment[] — List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document. Attachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request. - `attachmentId` string, uuid — When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `createdAt` string, date-time — The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `updatedAt` string, date-time — The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment. - `filename` string — If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type. - `mimeType` string — The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing. - `pageNumber` integer — If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish. - `side` 'FRONT' | 'BACK' — Indicates whether the attachment is the front or back side of a document. - `type` string — General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, images, or both). - "DOC": Word document, RTF, etc. - "ZIP": Any compressed file(s). - `location` string — Reference to where the data can be retrieved from. - `data` union, required — A Base64-encoded string or URI representing the data. - object - … - object - … - `lastMalwareScanAt` string, date-time - `retrievalStatus` 'NORMAL' | 'EXCLUDED' | 'FAILED' — The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provided empty. - "EXCLUDED": The retrieval request was not for 'full' data, or the object has been deleted, so the data is not included. - "FAILED": The data could not be retrieved from the secure document store. The retrievalStatus enum will not usually be set in a request. If an attachment in a response has a 'FAILED' retrieval state, then that object should not be sent back in a future update. It should either be omitted or the original data should be resent if it is available from another source. However, it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank data to be ignored, but other fields in the object will be updated if needed. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `name` IndividualName - `nameId` string — Include the nameId of an existing name for this individual to modify it - `language` string — The ISO-639-3 standard code that best represents the language and character set of the individual's name - `givenName` string — First name or given name - `middleName` string — Middle name(s) or middle initial(s) - `familyName` string, required — Last name, family name, or surname. - `otherName` string — Another name that this person may be known as, e.g., "Bob" as an alternative to "Robert". - `prefix` string — Letters or words that come before an individual's full name (e.g., title or honorific). - `suffix` string — Letters or words that come after an individual's full name (e.g., generational suffix). - `sourceId` string — The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map - `displayName` string — 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. - `alternateNames` IndividualNameAlternate[] — Other names that are legally registered or otherwise recorded, differing from the individual's primary English name (e.g., "李小龍"). Non-English names may be created as a conversion from the original format to complete the verification process. - `nameId` string — Include the nameId of an existing name for this individual to modify it. - `language` string — The ISO-639-3 standard code that best represents the language and character set of the individual's name. - `givenName` string — First name or given name. - `middleName` string — Middle name(s) or middle initial(s). - `familyName` string, required — Last name, family name, or surname. - `otherName` string — Other names to be stored with the entity. - `prefix` string — Element or series of letters that precede the individual's full name (e.g., title or honorific). - `suffix` string — Element or series of letters that follow the individual's full name (e.g., generational suffix). - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `displayName` string — 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. - `type` 'OTHER' | 'ALIAS' | 'PREVIOUS' — Classification of the individual's name in relation to any of their alternative names. - `dateOfBirth` DateOfBirth - `dateOfBirthId` string — As dates of birth are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a date of birth, include the dateOfBirthId in an update request for the individual. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `alternateDatesOfBirth` DateOfBirthAlternate[] — Other dates that are registered or otherwise recorded, differing from the individual's primary Gregorian date of birth (e.g., Islamic dates like "29 Jumada Al-Akhirah 1445"). Non-Gregorian date formats will be maintained; however, additional Gregorian dates of birth may be created as a conversion from the original format to complete the verification process. - `dateOfBirthId` string — As dates of birth are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a date of birth, include the dateOfBirthId in an update request for the individual. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `year` string — Year in "YYYY" format. - `month` string — Month in "MM" format. - `day` string — Day in "DD" format. - `unstructured` string — Raw date format without normalization or standardization to the Gregorian calendar. This can be used to provide non-Gregorian dates (e.g., Islamic dates). - `type` 'BUDDHIST' | 'DISCORDIAN' | 'GREGORIAN' | 'HEBREW' | 'ISLAMIC' | 'JULIAN' | 'LUNAR' | 'MESO_AMERICAN' | 'PERSIAN' | 'OTHER' — The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER. - `normalized` string, date — Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field. - `gender` Gender - `genderId` string - `gender` 'MALE' | 'FEMALE' | 'NON_BINARY' | 'OTHER' | 'UNSPECIFIED' - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `placeOfBirth` AddressPlaceOfBirth — The country or address where the individual was born. - `addressId` string — As addresses are added to an entity, they are assigned an ID to assist with tracking. - `sourceId` string — The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map. - `longForm` string — In some cases, the address will need to be supplied in "long form", such as when it is determined from a document scan, or is unparsable in some way. The service will attempt to convert it to its constituent parts where possible. WARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You have been warned. Failure to break down or disambiguate the address will result in an error. - `unstructuredLongForm` string — Raw, unformatted address as provided by the source. Not normalized or standardized. - `unitNumber` string — Unit/Apartment/Flat/Suite/etc. number - `buildingName` string — The name of the building, apartment block, condominium, etc. - `streetName` string — The name of the street. This field should ideally contain only the street name, without the street number or street type. In some cases, especially when auto-populated by external services (e.g., Google), it may include additional address components. For best results, keep the street name separate from the street number and street type. See https://apidocs.frankiefinancial.com/docs/working-with-addresses for more details. - `streetNumber` string — The number assigned to the property on the street. Typically a number, but can also be alphanumeric (e.g., 3A). - `streetType` string — The street type, such as Road, Street, Avenue, Circuit, etc. - `neighborhood` string — The neighborhood or suburb within the town or city. Use this only if you require both a suburb and a locality/town/city; otherwise, use the "locality" parameter. - `locality` string — The locality, borough, town, village, or city. - `district` string — The district, region, county, province, or cantonment. - `subdivision` string — The ISO 3166-2 alphanumeric code of the administrative area/state/sub-division, minus the country code, e.g., VIC (Victoria) or TX (Texas). - `country` string, required — The ISO 3166-1 alphanumeric three-letter code of the country, e.g., AUS, USA, IDR, KOR, etc. For more details, refer to: https://en.wikipedia.org/wiki/ISO_3166-1 - `postalCode` string — The postal, zip, or pin code of the address. - `nationality` string — ISO-3166-1 alpha-3 code of the individual's legal membership or affiliation with a nation. - `consents` Consent[] — List of consent types that have been given for this entity. - `type` 'GENERAL' | 'DOCS' | 'CREDITHEADER' | 'UNDER18' | 'PAYROLL' | 'INSURANCE' | 'SUPERANNUATION' — The type of consent given by an entity - `schemaVersion` integer - `sourceId` string — The source from which specific information was obtained. This is a link to an informationSource object in the informationSources map. - `informationSources` object — Map of information sources used across the response. - `relationships` IndividualRelationships - `duplicates` Relationship[] — List of duplicates for this individual. To determine which entity was marked as a duplicate, refer to the entity state of the relevant duplicate or reconcile using the process results. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `entityType` 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN' — The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN". - `origin` RelationshipOrigin — Details about the process that originated the relationship. - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request. - `entityType` 'INDIVIDUAL' | 'ORGANIZATION' | 'UNKNOWN' — The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN". - `processResultId` string — When a process result object is first created, it is assigned an ID. When updating the process result object, set the processResultID to the ID of the process result object you are referring to. - `createdAt` string, date-time — The date and time when the relationship origin record was created. - `serviceProfiles` ServiceProfile[] - `serviceProfileId` string — The unique identifier for the service profile. - `latestRiskAssessmentId` string — Unique identifier of the risk assessment. - `latestWorkflowExecutionId` string — The ID of the most recent workflow execution. Omitted if no workflows exist. - `entityId` string - `entityName` string - `entityType` string - `organizationType` string - `country` string — The ISO 3166 alpha-3 code representing the individual's country of residence or the business's country of registration. - `schemaVersion` integer — The version number of the schema. - `createdAt` string, date-time — The UTC date and time when this service profile was created. - `createdRequestId` string — The unique ULID identifier of the request that created this service profile. - `createdBy` string — The user or client that created this profile. - `updatedAt` string, date-time — The UTC date and time when this service profile was last updated, if applicable. - `updatedBy` string — The user or client that last updated this profile. - `updatedRequestId` string — The unique ULID identifier of the request that last updated this service profile. - `assignee` string — The name of the officer assigned to approve this profile. - `reviewer` string — The name of the officer assigned to review this profile. - `currentWorkflowId` string - `currentWorkflowName` string — The name of the current workflow, if applicable. - `workflowSummaries` WorkflowExecutionSummary[] - `schemaVersion` integer — Version of the schema used for this workflow execution. - `workflowName` string — Name of the workflow. - `workflowExecutionId` string — Unique identifier for the workflow execution. - `workflowExecutionState` 'COMPLETED' | 'CANCELED' | 'TERMINATED' | 'ERROR' | 'TIMEOUT' | 'IN_PROGRESS' — Current state of the workflow execution. Possible values: - COMPLETED: The workflow execution has completed successfully. - CANCELED: The workflow execution was canceled. - TERMINATED: The workflow execution was terminated before completion. - ERROR: The workflow execution encountered an error. - TIMEOUT: The workflow execution timed out. - IN_PROGRESS: The workflow execution is currently in progress. - `status` 'UNCHECKED' | 'IN_PROGRESS' | 'REVIEW' | 'PASS' | 'FAIL' | 'COMPLETE' | 'INCOMPLETE' | 'NEEDS_APPROVAL' | 'APPROVED' | 'REJECTED' | 'BLOCKED' | 'CLEAR' | 'URGENT' | 'MONITOR' — Outcome of this workflow execution. Possible results: - UNCHECKED: The workflow has not yet been run and has no result. - IN_PROGRESS: The workflow is currently running and awaiting completion. - REVIEW: The workflow produced results that require review. Check the risks and step results for more details. - PASS: The workflow successfully completed with a PASS recommendation. - FAIL: The workflow finished with a FAIL recommendation. - COMPLETE: The workflow has finished and the results are considered complete. PASS/FAIL is not required. - INCOMPLETE: The workflow has finished and the results are considered incomplete. PASS/FAIL is not required. - NEEDS_APPROVAL: The workflow requires an approval process. Once approved, re-run the workflow. - APPROVED: The workflow was approved, typically by an external source such as a human. - REJECTED: The workflow was rejected, typically by an external source such as a human. - BLOCKED: The workflow was blocked from completing. Manual review is required. - CLEAR: The workflow completed with no issues raised. Often used for ongoing monitoring workflows. - URGENT: The workflow completed with matters requiring urgent review. Often used for ongoing monitoring workflows that return sanctions or similarly critical items. - MONITOR: The workflow completed and further monitoring is required. Should be manually reviewed. - `statusOverrideAt` string, date-time — Timestamp when the status override occurred. - `statusOverrideRequestId` string — Request ID associated with the status override. - `statusOverrideBy` string — Identifier of the user who performed the status override. - `riskAssessment` RiskAssessment - `serviceProfileId` string, required — Unique identifier of the Service Profile. - `riskAssessmentId` string — Unique identifier of the risk assessment. - `workflowId` string, required — Unique identifier of the workflow. - `workflowExecutionId` string, required — Unique identifier of the workflow execution. - `entityId` string, required — Unique identifier of the entity being assessed. - `schemaVersion` integer — Version of the risk assessment schema. - `createdAt` string, date-time — Timestamp when the risk assessment was created. - `updatedAt` string, date-time — Timestamp when the risk assessment was last updated. - `updatedBy` string — Identifier of the user or system that updated this assessment. - `updatedRequestId` string — Identifier of the request that updated this assessment. - `workflowRiskScore` number — Risk score calculated for the workflow. - `workflowRiskLevel` 'UNKNOWN' | 'LOW' | 'MEDIUM' | 'HIGH' | 'UNACCEPTABLE' — The risk level classification: - UNKNOWN: Risk level is not determined. - LOW: Low risk. - MEDIUM: Medium risk. - HIGH: High risk. - UNACCEPTABLE: Risk level is unacceptable. - `riskScore` number — Risk score calculated for the entity. - `riskLevel` 'UNKNOWN' | 'LOW' | 'MEDIUM' | 'HIGH' | 'UNACCEPTABLE' — The risk level classification: - UNKNOWN: Risk level is not determined. - LOW: Low risk. - MEDIUM: Medium risk. - HIGH: High risk. - UNACCEPTABLE: Risk level is unacceptable. - `isOutdated` boolean — Indicates whether the assessment is out of date, either due to manual updates or changes to risk factors that were assessed. - `riskFactors` RiskFactor[] — List of risk factors considered in this assessment. - `riskFactorId` string — Unique identifier of the risk factor. - `factor` string — Name of the Frankie risk factor. - `value` string — Value assigned to the risk factor. - `score` number — Risk score assigned to the factor (based on customer configuration). - `description` string — Description of the risk factor. - `workflowExecutionId` string — Unique identifier of the workflow execution in which the risk factor was generated. - `stepResultId` string — Unique identifier of the step result if the factor originated from a step. - `manualOverrideScore` number — If present, this score overrides all others and is used as the final score in risk assessment. - `status` 'VALID' | 'STALE' | 'OVERRIDDEN' | 'DISCARDED' — The current status of the risk factor: - VALID: The risk factor is applicable to the entity. - STALE: The risk factor is no longer applicable to the entity. If this status is returned, it means that at the time of risk assessment, the risk factor was valid. - OVERRIDDEN: The risk factor was manually overridden. If present, manualOverrideScore was used for risk score calculation in the risk assessment. - DISCARDED: The risk factor was added during workflow execution but was discarded at a later stage in the same workflow. This factor was not used in the final risk assessment. - `createdAt` string, date-time — Timestamp when the risk factor was created. - `updatedAt` string, date-time — Timestamp when the risk factor was last updated. - `updatedBy` string — Identifier of the user or system that updated this risk factor (e.g., System:; or User:). - `updatedRequestId` string — Identifier of the request that updated this risk factor. - `createdServiceProfileId` string, uuid — Identifier of the service profile associated with this risk factor when it was created. - `createdWorkflowExecutionId` string — Identifier of the workflow execution that originally created the risk factor. - `createdStepResultId` string — Identifier of the step result that originally created the risk factor. - `isManual` boolean — Indicates if the workflow was executed manually. - `steps` WorkflowExecutionSteps - `order` string[] - `passed` string[] - `failed` string[] - `incomplete` string[] - `notApplicable` string[] - `startedAt` string, date-time — The timestamp when the workflow execution started. - `endedAt` string, date-time — The timestamp when the workflow execution ended. - `issues` WorkflowIssue[] — List of issues encountered during the workflow execution. - `issueId` string — Unique identifier for the risk issue. - `category` 'AML' | 'BAD_DATA' | 'BIOMETRICS' | 'BLOCKLISTED' | 'DECEASED' | 'DEVICE' | 'DOCUMENT' | 'DUPLICATE' | 'EXPIRY' | 'FRAUD' | 'IDV' | 'INFORMATIONAL' | 'KYC' | 'SYSTEM' | 'VERIFY' | 'VISA' | 'WATCHLIST' | 'ACTIVITY', required — General category of issue found: - AML: Anti-Money Laundering issues. - BAD_DATA: Indicates that the data provided is invalid or incorrect. - BIOMETRICS: Issues found during a biometrics check. - BLOCKLISTED: The entity has a hit on a blocklist. - DECEASED: Indicates that the entity is deceased. - DEVICE: Issues found during device checks. - DOCUMENT: Issues found during a document check. - DUPLICATE: Indicates that the entity has duplicates. - EXPIRY: Indicates that a process or document for the entity has expired. - FRAUD: Possible fraud detected. - IDV: Issues found during an Identity Verification (IDV) process. - INFORMATIONAL: Informational messages that are not issues but are required to be returned. - KYC: Issues found during a Know Your Customer (KYC) process. - SYSTEM: System-level issues. - VERIFY: Issues found during a verification process. - VISA: Issues found during a visa check. - WATCHLIST: Issues found during a watchlist check. - ACTIVITY: Issues found during an activity process. - `issue` 'AML_ISSUE' | 'BAD_DATA_ADDRESS' | 'BAD_DATA_DOB' | 'BAD_DATA_EMAIL' | 'BAD_DATA_ID' | 'BAD_DATA_MOBILE' | 'BAD_DATA_NAME' | 'BLOCKED' | 'COMPROMISED_DOCUMENT' | 'CREDIT_HEADER' | 'DATA_COMPARISON' | 'DATA_CONSISTENCY' | 'DATA_VALIDATION' | 'DENY_LIST' | 'DECEASED' | 'DEVICE_FRAUD_MATCH' | 'DEVICE_INVALID' | 'DOCUMENT_COMPARISON' | 'DUPLICATE' | 'FRAUD_CHECK' | 'FRAUD_DEVICE' | 'FRAUD_IP_ADDRESS' | 'FRAUD_EMAIL_ADDRESS' | 'FRAUD_PHONE_NUMBER' | 'FRAUD_ISSUE' | 'FRAUD_LIST' | 'IMAGE_INTEGRITY' | 'INTERNAL_MATCH' | 'LIVENESS_DETECTION' | 'MATCHED_EXTERNAL' | 'MATCHED_INTERNAL' | 'MATCHED_SHARED' | 'MEDIA' | 'NOT_FOUND' | 'OCR' | 'PARTIAL' | 'PEP' | 'REQUIRES_AML' | 'REQUIRES_IDV' | 'REQUIRES_KYC' | 'REQUIRES_VISA' | 'SANCTION' | 'SERVICE_ERROR' | 'SERVICE_TIMEOUT' | 'VISA_FAILED' | 'VISUAL_AUTHENTICITY' | 'WATCHLIST' | 'ACTIVITY_AML' | 'ACTIVITY_FRAUD' | 'ACTIVITY_DEVICE', required — For each category, this provides the specific issue type. AML: - PEP: The entity has Politically Exposed Person (PEP) hits. - SANCTION: The entity has sanction hits. - MEDIA: The entity has adverse media hits. - WATCHLIST: The entity has watchlist hits. BAD_DATA: - BAD_DATA_NAME: Name is required for verification but is missing or unusable due to data quality issues. - BAD_DATA_DOB: Date of Birth is required for verification but is missing or unusable due to data quality issues. - BAD_DATA_ADDRESS: Address is required for verification but is missing or unusable due to data quality issues. - BAD_DATA_ID: ID is required for verification but is missing or unusable due to data quality issues. - BAD_DATA_EMAIL: Email is required for verification but is missing or unusable due to data quality issues. - BAD_DATA_MOBILE: Mobile is required for verification but is missing or unusable due to data quality issues. BLOCKLISTED: - MATCHED_INTERNAL: The entity matched an internal blocklist. - MATCHED_SHARED: The entity matched a shared blocklist. - MATCHED_EXTERNAL: The entity matched an external blocklist. DECEASED: - DECEASED: The person whose data is being verified is deceased. DEVICE: - DEVICE_FRAUD_MATCH: Fraud detected on the device. - DEVICE_INVALID: The device is invalid. DUPLICATE: - DUPLICATE: The entity is a duplicate of another entity. EXPIRY: - REQUIRES_KYC: KYC process needs to be re-initiated. - REQUIRES_IDV: IDV process needs to be re-initiated. - REQUIRES_AML: AML process needs to be re-initiated. - REQUIRES_VISA: Visa process needs to be re-initiated. FRAUD: - FRAUD_LIST: The entity is on a fraud list. - FRAUD_CHECK: Fraud detected during checks. - FRAUD_DEVICE: Device fraud detected. - FRAUD_IP_ADDRESS: IP address fraud detected. - FRAUD_EMAIL_ADDRESS: Email address fraud detected. - FRAUD_PHONE_NUMBER: Phone number fraud detected. IDV: - DATA_COMPARISON: Data comparison issue. - DATA_VALIDATION: Data validation issue. - DATA_CONSISTENCY: Data consistency issue. - VISUAL_AUTHENTICITY: Visual authenticity issue. - IMAGE_INTEGRITY: Image integrity issue. - COMPROMISED_DOCUMENT: Document is compromised. - LIVENESS_DETECTION: Liveness detection failed. - DOCUMENT_COMPARISON: Document comparison issue. INFORMATIONAL: - CREDIT_HEADER: Credit header information was returned as part of a credit agency check. KYC: - PARTIAL: The KYC check was only partially successful. - NOT_FOUND: No match was found for the given data. OCR: - OCR: The OCR data does not match what was entered by the user. SYSTEM: - SERVICE_TIMEOUT: All providers have timed out. - SERVICE_ERROR: All providers have returned an error or an internal error has occurred. VISA: - DENY_LIST: The entity matched a visa deny list. - VISA_FAILED: Visa check failed from the provider. WATCHLIST: - INTERNAL_MATCH: The entity matched an internal watchlist. ACTIVITY: - ACTIVITY_AML: AML-related activity issue. - ACTIVITY_FRAUD: Fraud-related activity issue. - ACTIVITY_DEVICE: Device-related activity issue. - `workflowExecutionId` string — Identifier of the workflow execution in which this issue was generated. - `stepResultId` string — Identifier of the step from which this issue originated, if applicable. - `isCleared` boolean — Indicates if this specific issue has been manually flagged as addressed. - `createdBy` string — User or system that created this issue. - `createdAt` string, date-time — The timestamp when the issue was created. - `updatedAt` string, date-time — The timestamp when the issue was last updated. - `updatedBy` string — User or system that last updated this issue (e.g., System: or User:). - `updatedRequestId` string — Identifier of the request that updated this issue. - `severity` 'INFO' | 'REVIEW' | 'BLOCK' | 'WARNING' | 'CRITICAL' | 'ERROR', required — The severity level of the issue. Possible values: - INFO: Informational only. - REVIEW: Requires review. - BLOCK: Blocks further processing. - WARNING: Warning, but not blocking. - CRITICAL: Critical issue. - ERROR: Error encountered. - `lifecyclePhase` 'ONBOARDING' | 'MONITORING' | 'OTHER' — Specifies the lifecycle phase of the customer in which this workflow is executed: - ONBOARDING: Workflow is in the onboarding stage. - MONITORING: Workflow is in the monitoring stage. - OTHER: Workflow is in another stage. - `monitoringTypes` MonitoringType[] — The types of monitoring that subscribe to the workflow. - `serviceName` string — The name of the service associated with this profile. - `customerReference` string — Customer-specific identifier(s). - `subscriptions` ServiceProfileSubscription[] — The list of subscriptions associated with the service profile. A subscription determines if the service profile is subscribed to a particular ongoing process. - `serviceProfileId` string — The unique identifier of the service profile. - `status` 'ENABLED' | 'DISABLED' — Indicates whether the subscription is currently active and operational. - `type` 'AML' | 'ACTIVITY' — Specifies the type of service profile subscription. This value determines the category of the service profile subscription. - `workflowName` string — The name of the monitoring workflow executed when a monitoring alert occurs. - `workflowId` string — The unique identifier of the monitoring workflow. - `enabledAt` string, date-time — The date and time when the subscription was most recently enabled. - `enabledRequestId` string — The request identifier for the most recent enable action. - `enabledBy` string — The user who most recently enabled the subscription. - `disabledAt` string, date-time — The date and time when the subscription was most recently disabled. - `disabledRequestId` string — The request identifier for the most recent disable action. - `disabledBy` string — The user who most recently disabled the subscription. - `state` 'INIT' | 'AUTO' | 'ACTIVE' | 'ARCHIVED' | 'BLOCKLISTED' | 'INACTIVE' | 'DELETED' | 'DUPLICATE' — Current state of the Service Profile - INIT: Initial state when the profile is created. - AUTO: Automatically assigned state, typically after initial processing. - ACTIVE: The profile is active and in use. - ARCHIVED: The profile has been archived and is no longer active. - BLOCKLISTED: The profile is blocked from further actions. - INACTIVE: The profile is inactive, not currently in use. - DELETED: The profile has been deleted. - DUPLICATE: The profile is a duplicate of another existing profile. - `requestId` string, required — The unique request identifier for the API call made. ## Other responses - `400` — Bad request - `401` — Unauthorized - `500` — Internal Server Error - `502` — Bad Gateway - `503` — Service Unavailable --- [API](https://skmtc.net/frankieone/apis/kyc-v2-api.md) · [All operations](https://skmtc.net/frankieone/apis/kyc-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frankieone/kyc-v2-api/revisions/880b27506cbb/schema)