---
title: "Get all documents for an entity"
method: GET
path: "/v2/individuals/{entityId}/documents"
tags: ["Individual Documents"]
---

# Get all documents for an entity

`GET /v2/individuals/{entityId}/documents`

Get all documents for an entity.

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string
- `X-Frankie-Username` string

## Response `200`

OK

- 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
          - `uri` string, required — URI identifying the resource location.
        - object
          - `base64` string, required — Base64-encoded string of the raw attachment data.
      - `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
          - `uri` string, required — URI identifying the resource location.
        - object
          - `base64` string, required — Base64-encoded string of the raw attachment data.
      - `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
          - `uri` string, required — URI identifying the resource location.
        - object
          - `base64` string, required — Base64-encoded string of the raw attachment data.
      - `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
          - `uri` string, required — URI identifying the resource location.
        - object
          - `base64` string, required — Base64-encoded string of the raw attachment data.
      - `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 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)