Get a single document by its id.
Path parameters
Headers
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.
Query parameters
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
Response
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.
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
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.
The expiry date of the document in YYYY-MM-DD format.
The issue date of the document in YYYY-MM-DD format.
The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report).
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.