Media resources

To view all submitted user information related to a session, you will need to use the resources container to find the media id's linked to the user information.

Document resources

The ID documents container includes all the ID document resources which includes ID document images and extracted document data. The documents fields media ID contains the data extracted from the document, and the page media id's will contain the image of the ID document.

Node.jsJavaPhpPythonCsharpGoJson

Copy

idvClient

.getSession(sessionId)

.then((session) => {

// Returns all resources in the session

const resources = session.getResources();

// Returns a collection of ID Documents

const idDocuments = resources.getIdDocuments();

idDocuments.map((idDocument) => {

// Gets the UUID of the document resource

const id = idDocument.getId();

// Returns the ID Document Type

const documentType = idDocument.getDocumentType();

// Returns the ID Document country

const issuingCountry = idDocument.getIssuingCountry();

// Returns pages of an ID Document

const pages = idDocument.getPages();

// Get pages media ids

const pageMediaIds = pages.map((page) => {

GetSessionResult sessionResult = docScanClient.getSession(sessionId);

// Returns all resources in the session

ResourceContainer resources = sessionResult.getResources();

// Returns a collection of ID Documents

List<? extends IdDocumentResourceResponse> idDocuments = resources.getIdDocuments();

for (IdDocumentResourceResponse idDocument: idDocuments) {

// Gets the UUID of the document resource

String id = idDocument.getId();

// Returns the ID Document Type

String documentType = idDocument.getDocumentType();

// Returns the ID Document country

String issuingCountry = idDocument.getIssuingCountry();

// Returns the pages of an ID Document

List<? extends PageResponse> pages = idDocument.getPages();

// Get the page media ids

<?php

$sessionResult = $docScanClient->getSession($sessionId);

// Returns all resources in the session

$resources = $sessionResult->getResources();

// Returns a collection of ID Documents

$idDocuments = $resources->getIdDocuments();

foreach ($idDocuments as $idDocument) {

// Gets the UUID of the document resource

$id = $idDocument->getId();

// Returns the ID Document Type

$documentType = $idDocument->getDocumentType();

// Returns the ID Document country

$issuingCountry = $idDocument->getIssuingCountry();

// Returns the pages of an ID Document

$pages = $idDocument->getPages();

// Get pages media ids

$pageMediaIds = [];

foreach ($pages as $page) {

if ($page->getMedia() && $page->getMedia()->getId()) {

session_result = doc_scan_client.get_session(session_id)

# Returns all resources in the session

resources = session_result.resources

# Returns a collection of ID Documents

id_documents = resources.id_documents

for id_document in id_documents:

# Gets the UUID of the document resource

id = id_document.id

# Returns the ID Document Type

document_type = id_document.document_type

# Returns the ID Document country

issuing_country = id_document.issuing_country

# Returns the pages of an ID Document

pages = id_document.pages

# Get pages media ids

page_media_ids = []

for page in pages:

if page.media and page.media.id:

page_media_ids.append(page.media.id)

GetSessionResult sessionResult = docScanClient.GetSession(sessionId);

// Returns all resources in the session

ResourceContainer resources = sessionResult.Resources;

// Returns a collection of ID Documents

List<IdDocumentResourceResponse> idDocuments = resources.IdDocuments;

foreach (IdDocumentResourceResponse idDocument in idDocuments)

{

// Gets the UUID of the document resource

string id = idDocument.Id;

// Returns the ID Document Type

string documentType = idDocument.DocumentType;

// Returns the ID Document country

string issuingCountry = idDocument.IssuingCountry;

// Returns the pages of an ID Document

List<PageResponse> pages = idDocument.Pages;

// Get the page media ids

ArrayList pageMediaIds = new ArrayList();

// COMING SOON

›

›

{…}

Liveness resources

The liveness container also includes all the liveness and face capture resources.

Passive Liveness

Active Liveness

Supplementary document resources

The supplementary documents container includes all the supplementary document resources which includes the supplementary document image/file and the extracted data.

Fetching media

Once the media IDs have been successfully retrieved, they can be utilised to fetch the corresponding data. There are two primary data types available for retrieval, an image or JSON data.

Images

JSON