Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
Individual Documents

Get a single document by it's id.

Get a single document by it's id.

get/v2/individuals/{entityId}/documents/{documentId}

Query parameters

level'meta' | 'base64'

Determines what level of detail to return in the response

  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and images as base64

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-Usernamestring
Example:fred.flintstone@frankieone.com

Username provided by API caller

Response

OK

documentIdstring 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.

entityIdstring

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.

primaryIdentifierstring

The primary ID number of the document, e.g., the ID number on a driver licence.

secondaryIdentifierstring

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.
subtypestring

The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report).

subdivisionstring

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.

countrystring 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

createdAtstring date-time

The date and time when the document record was created, in ISO 8601 format.

updatedAtstring date-time

The date and time when the document record was last updated, in ISO 8601 format.

sourceIdstring

The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map.

customAttributesCustomAttributes

Example response

{
  "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "expiryDate": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "normalized": "1990-03-31"
  },
  "issueDate": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "normalized": "1990-03-31"
  },
  "primaryIdentifier": "000734130",
  "secondaryIdentifier": "P0001975",
  "subtype": "Photo Comparison",
  "subdivision": "VIC",
  "country": "AUS",
  "createdAt": "2024-01-15T02:18:11.365Z",
  "updatedAt": "2025-01-16T02:18:11.365Z",
  "validFrom": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "normalized": "1990-03-31"
  },
  "validTo": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "normalized": "1990-03-31"
  },
  "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
  "supplementaryData": {
    "reference": "1"
  },
  "attachments": [
    {
      "data": {
        "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
      }
    }
  ]
}