Skip to main content
GET
/
v2.1
/
organizations
/
{entityId}
/
documents
/
{documentId}
Get a single document by its id.
curl --request GET \
  --url https://api.uat.frankie.one/v2.1/organizations/{entityId}/documents/{documentId} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "type": "OTHER",
  "country": "AUS",
  "class": "IDENTITY",
  "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "expiryDate": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "type": "GREGORIAN",
    "normalized": "1990-03-31"
  },
  "issueDate": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "type": "GREGORIAN",
    "normalized": "1990-03-31"
  },
  "primaryIdentifier": "000734130",
  "secondaryIdentifier": "P0001975",
  "subtype": "Photo Comparison",
  "subdivision": "VIC",
  "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",
    "type": "GREGORIAN",
    "normalized": "1990-03-31"
  },
  "validTo": {
    "year": "1990",
    "month": "03",
    "day": "27",
    "unstructured": "12 Rajab 1445 AH",
    "type": "GREGORIAN",
    "normalized": "1990-03-31"
  },
  "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
  "supplementaryData": {
    "type": "NATIONAL_HEALTH_ID",
    "reference": "1",
    "nameOnCardLine1": "<string>",
    "nameOnCardLine2": "<string>",
    "nameOnCardLine3": "<string>",
    "nameOnCardLine4": "<string>",
    "middleNameOnCard": "<string>"
  },
  "customAttributes": {},
  "attachments": [
    {
      "data": {
        "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
      },
      "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sourceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "filename": "<string>",
      "mimeType": "<string>",
      "pageNumber": 123,
      "side": "FRONT",
      "type": "<string>",
      "location": "<string>",
      "lastMalwareScanAt": "2023-11-07T05:31:56Z",
      "retrievalStatus": "NORMAL"
    }
  ]
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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-Username
string

Username provided by API caller

Example:

"[email protected]"

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

​
documentId
string
required

Unique identifier for a document

Query Parameters

​
level
enum<string>
default:meta

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
Available options:
meta,
base64

Response

OK

​
type
enum<string>
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.
  • "DEED_OF_VARIATION": Deed of variation document.
  • "REGISTER_OF_UNIT_HOLDERS": Register of unit holders document.
  • "PARTNERSHIP_AGREEMENT": Partnership agreement documents.
  • "ADMIN_CHANGE": Change of administrator.
  • "COMPANY_REPORT": Registry-filed company reports.
  • "ORGANIZATION_PROFILE": Organization profile document.
  • "ORGANIZATION_OWNERSHIP": Organization ownership document.

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.
Available options:
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,
DEED_OF_VARIATION,
REGISTER_OF_UNIT_HOLDERS,
PARTNERSHIP_AGREEMENT,
ADMIN_CHANGE,
COMPANY_REPORT,
CHECK_RESULTS,
AVIATION_SECURITY_ID,
MARITIME_SECURITY_ID,
ORGANIZATION_PROFILE,
ORGANIZATION_OWNERSHIP
​
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

Maximum string length: 3
Example:

"AUS"

​
class
enum<string>

The classification of the document, indicating how it should be used or interpreted.

Available options:
OTHER,
IDENTITY,
SUPPORTING,
REPORT
Example:

"IDENTITY"

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

Example:

"92de15f64-5717-4562-b3fc-2c963f6665a7"

​
entityId
string

Entities are assigned a FrankieOne 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.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
expiryDate
object

The expiry date of the document in YYYY-MM-DD format.

​
issueDate
object

The issue date of the document in YYYY-MM-DD format.

​
primaryIdentifier
string

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

Example:

"000734130"

​
secondaryIdentifier
string

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

Example:

"P0001975"

​
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).

Example:

"Photo Comparison"

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

Example:

"VIC"

​
createdAt
string<date-time>

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

Example:

"2024-01-15T02:18:11.365Z"

​
updatedAt
string<date-time>

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

Example:

"2025-01-16T02:18:11.365Z"

​
validFrom
object

The date when the validity period for this document began, if applicable.

​
validTo
object

The date when the validity period for this document ended, if applicable.

​
sourceId
string

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

Example:

"324f15f64-5717-4562-b3fc-2c963f66ffa1"

​
supplementaryData
object

Supplementary information relevant to a national health id.

​
customAttributes
object
​
attachments
object[]

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.