KYC V2 APIIndividual Documents

Get a single document by its id.

Get a single document by its id.

Path parameters

entityIdstringRequired
documentIdstringRequired

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-ChannelstringOptional

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-UsernamestringOptional
Username provided by API caller

Query parameters

levelenumOptionalDefaults to 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
Allowed values:

Response

OK
typeenum

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.
countrystring<=3 characters

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

documentIdstring or nullformat: "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 or null

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.

expiryDateobject or null

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

issueDateobject or null

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

primaryIdentifierstring or null
The primary ID number of the document, e.g., the ID number on a driver licence.
secondaryIdentifierstring or null
The secondary ID number of the document, e.g., the card number on a driver licence.
subtypestring or null

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 or null

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.

createdAtstring or nullformat: "date-time"
The date and time when the document record was created, in ISO 8601 format.
updatedAtstring or nullformat: "date-time"
The date and time when the document record was last updated, in ISO 8601 format.
validFromobject or null
The date when the validity period for this document began, if applicable.
validToobject or null
The date when the validity period for this document ended, if applicable.
sourceIdstring or null
The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map.
supplementaryDataobject or null
Supplementary information relevant to a specific document or report type.
customAttributesmap from strings to objects or null
attachmentslist of objects or null
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.

Errors