Get a single document by it’s id.
Unique FrankieOne identifier for an entity
Unique identifier for a document
Your Customer ID provided by FrankieOne
Your Customer Child ID provided by FrankieOne
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.
Username provided by API caller
Determines what level of detail to return in the response
OK
Valid ID types
NOTE: these cannot be used as a supporting document
Business related documentation
Special document types
The ISO3166 alpha3 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
As documents are added to an entity, they’re assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request call.
Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an 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 call.
The expiry date of the document in YYYY-MM-DD format
The issued date of the document in YYYY-MM-DD format
The primary ID number of the document e.g the ID number on a driver licence
The secondary ID number of the document e.g the card number on a driver licence
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 ISO3166 subdivision/region where the ID was distributed e.g. “VIC” for The Australian state of Victoria or “MA” for the US state of Massachusetts
The date when the document was created in YYYY-MM-DD format
The date when the document was updated in YYYY-MM-DD format
when did the validity period begin for this document, if applicable
when did the validity period end for this document, if applicable
The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map.
Supplementary information relevant to a specific document or report type.
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.