Search
Welcome
Identity Verification Product Guide
Identity Verification SDK
Mobile SDK
No Code (Portal)
Face Auth
Face Search
DBS/RTW & Yoti Global Identity
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
Retrieve user data
AI Tools
Summarize Page
Copy Markdown
Open in ChatGPT
Open in Claude
Connect to Cursor
Connect to VS Code
To view all submitted user information related to a session, use the resources container.
Document resources
The resources container includes all the document resources.
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) => {
if (page.getMedia() && page.getMedia().getId()) {
return page.getMedia().getId();
}
return null;
});
//return document id photo media id
const documentPhoto = idDocument.getDocumentIdPhoto().getMedia().getId();
// Returns document fields object
const documentFields = idDocument.getDocumentFields();
// Get document fields media id
let documentFieldsMediaId = null;
if (documentFields) {
documentFieldsMediaId = documentFields.getMedia().getId();
}
// Get expanded document fields media id
const expandedFields = idDocument.getExpandedDocumentFields()
const expandedFieldsMediaId = expandedFields.getMedia().getId();
});
// Returns a collection of Supplementary Documents
const supplementaryDocuments = resources.getSupplementaryDocuments();
supplementaryDocuments.map((supplementaryDocument) => {
// Gets the UUID of the document resource
const supplementaryID = supplementaryDocument.getId();
// Returns the supplementary Document Type
const suppDocumentType = supplementaryDocument.getDocumentType();
// Returns the supplementary Document country
const suppIssuingCountry = supplementaryDocument.getIssuingCountry();
// If a file was uploaded
const file = supplementaryDocument.getDocumentFile();
const fileMedia = file.getMedia().getId();
// If an image was uploaded - there will only be 1 image in this array
const suppPages = supplementaryDocument.getPages();
const suppImageId = suppPages[0].getMedia().getId();
// Returns document fields object
const suppDocumentFields = supplementaryDocument.getDocumentFields();
// Get document fields media id
let suppDocumentFieldsMediaId = null;
if (suppDocumentFields) {
suppDocumentFieldsMediaId = suppDocumentFields.getMedia().getId();
}
});
})
.catch((error) => {
console.log(error);
// handle error
});
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
ArrayList<String> pageMediaIds = new ArrayList<>();
for (PageResponse page: pages) {
if (page.getMedia() != null && page.getMedia().getId() != null) {
pageMediaIds.add(page.getMedia().getId());
}
}
// Get Id docmunent photo media id
String documentPhotoMediaId = idDocument.getDocumentIdPhoto().getMedia().getId();
// Returns document fields object
DocumentFieldsResponse documentFields = idDocument.getDocumentFields();
// Get document fields media id
String documentFieldsMediaId = null;
if (documentFields != null) {
documentFieldsMediaId = documentFields.getMedia().getId();
}
// Returns expanded document fields object
ExpandedDocumentFieldsResponse expandedDocumentFields = idDocument.getExpandedDocumentFields();
// Get expanded document fields media id
String expandedDocumentFieldsMediaId = null;
if (documentFields != null) {
expandedDocumentFieldsMediaId = expandedDocumentFields.getMedia().getId();
}
}
<?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()) {
array_push($pageMediaIds, $page->getMedia()->getId());
}
}
// Get Id document photo media id
$documentPhotoId = $idDocument->getDocumentIdPhoto()->getMedia()->getId();
// Returns document fields object
$documentFields = $idDocument->getDocumentFields();
// Get document fields media id
$documentFieldsMediaId;
if ($documentFields) {
$documentFieldsMediaId = $documentFields->getMedia()->getId();
}
// Returns expanded document fields object
$expandedDocumentFields = $idDocument->getExpandedDocumentFields();
// Get dexpanded document fields media id
$expandedDocumentFieldsMediaId;
if ($expandedDocumentFields) {
$expandedDocumentFieldsMediaId = $expandedDocumentFields->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)
# Get Id document photo media id
document_photo_media_id = id_document.document_photo.media.id
# Returns document fields object
document_fields = id_document.document_fields
# Get document fields media id
document_fields_media_id = None
if document_fields:
document_fields_media_id = document_fields.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();
foreach (PageResponse page in pages)
{
if (page.Media != null && page.Media.Id != null)
{
pageMediaIds.Add(page.Media.Id);
}
}
// Get Id document photo media id
string documentPhotoMediaId = idDocument.DocumentPhoto.Media.Id;
// Returns document fields object
DocumentFieldsResponse documentFields = idDocument.DocumentFields;
//Get document fields media id
string documentFieldsMediaId = null;
if (documentFields != null)
{
documentFieldsMediaId = documentFields.Media.Id;
}
// Returns expanded document fields object
ExpandedDocumentFieldsResponse expandedDocumentFields = idDocument.ExpandedDocumentFields;
//Get expanded document fields media id
string expandedDocumentFieldsMediaId = null;
if (expandedDocumentFields != null)
{
expandedDocumentFieldsMediaId = expandedDocumentFields.Media.Id;
}
}
{
"resources": {
"id_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"source": {
"type": "END_USER"
},
"document_type": "PASSPORT",
"issuing_country": "string",
"pages": [
{
"capture_method": "CAMERA",
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
},
"frames": [
{
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
}
]
}
],
"document_fields": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "JSON",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"document_id_photo": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"created_at": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z",
"tasks": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "DONE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z",
"generated_media": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE"
}
],
"generated_checks": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "ID_DOCUMENT_TEXT_DATA_CHECK"
}
],
"type": "ID_DOCUMENT_TEXT_DATA_EXTRACTION"
}
]
}
],
"supplementary_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"source": {
"type": "END_USER"
},
"document_type": "UTILITY_BILL",
"issuing_country": "string",
"file": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"pages": [
{
"capture_method": "CAMERA",
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
},
"frames": [
{
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
}
]
}
],
"document_fields": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"created_at": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z",
"tasks": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "DONE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z",
"generated_media": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE"
}
],
"generated_checks": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "ID_DOCUMENT_TEXT_DATA_CHECK"
}
],
"type": "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION"
}
]
}
],
"liveness_capture": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"source": {
"type": "END_USER"
},
"liveness_type": "STATIC",
"facemap": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"frames": [
{
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
}
],
"created_at": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z",
"tasks": [],
"image": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
}
}
]
}
}
›
⌄
⌄
⌄
⌄
⌄
⌄
⌄
⌄
⌄
Liveness resources
The resources container also includes all the liveness and face capture resources.
// Returns a collection of liveness capture resources
const livenessCapture = resources.getLivenessCapture();
// Returns a collection of liveness capture resources
List<? extends LivenessResourceResponse> livenessCapture = resources.getLivenessCapture();
// Returns a collection of face capture resources
List<? extends FaceCaptureResourceResponse> faceCapture = resources.getFaceCapture();
// Returns a collection of liveness capture resources
$livenessCapture = $resources->getLivenessCapture();
// Returns a collection of face capture resources
$faceCapture = $resources->getFaceCapture();
# Returns a collection of liveness capture resources
liveness_capture = resources.liveness_capture
// Returns a collection of liveness capture resources
List<LivenessResourceResponse> livenessCapture = resources.LivenessCapture;
// Returns a collection of face capture resources
List<FaceCaptureResourceResponse> faceCapture = resources.FaceCapture;
// Returns a collection of liveness capture resources
staticLivenessResources = resources.livenessCapture
Passive liveness
// Returns Passive (Static) liveness resources
const staticLivenessResources = resources.getStaticLivenessResources();
staticLivenessResources.forEach((liveness) => {
// Get the liveness id
const livenessId = liveness.getId();
// Get the liveness image media
const livenessMedia = liveness.getImage();
// Get the liveness media id
const livenessMediaId = livenessMedia.getId();
});
// Returns Passive (Static) liveness resources
List<? extends StaticLivenessResourceResponse> staticLivenessResources = resources.getLivenessCapture();
for (StaticLivenessResourceResponse liveness : staticLivenessResources) {
// Get the liveness id
String livenessId = liveness.getId();
// Get the liveness image media
MediaResponse livenessMedia = liveness.getImage().getMedia();
// Get the liveness media id
const livenessMediaId = livenessMedia.getId();
}
// Returns Passive (Static) liveness resources
$staticLivenessResources = $resources->getStaticLivenessResources();
foreach ($staticLivenessResources as $liveness) {
// Get the liveness id
$livenessId = $liveness->getId();
// Get the liveness image media
$livenessMedia = $liveness.getImage();
// Get the liveness media id
$livenessMediaId = $livenessMedia.getId();
});
# Coming soon
// Returns Passive (Static) liveness resources
List<StaticLivenessResourceResponse> staticLivenessResources = resources.StaticLivenessResourceResponse;
foreach (StaticLivenessResourceResponse liveness in staticLivenessResources)
{
// Get the liveness id
String livenessId = liveness.Id;
// Get the liveness image media
MediaResponse livenessMedia = liveness.image.Media;
// Get the liveness media id
String livenessMediaId = livenessMedia.Id;
}
// Returns Passive (Static) liveness resources
staticLivenessResources = resources.staticLivenessResources
for _, liveness := range staticLivenessResources {
// Get the liveness id
livenessId := liveness.ID
// Get the liveness image media
livenessMedia := livenessImage.Image.Media
// Get the liveness media id
livenessMediaId := livenessMedia.ID
}
Active liveness
// Returns Active (Zoom) liveness resources
const zoomLivenessResources = resources.getZoomLivenessResources();
zoomLivenessResources.forEach((liveness) => {
// Get the liveness id
const livenessId = liveness.getId();
// Get the liveness facemap
const facemap = liveness.getFaceMap();
// Get the liveness frames
const frames = liveness.getFrames();
frames.forEach((frame) => {
// Get the frame media
const frameMedia = frame.getMedia();
// Get the frame media id
const frameMediaId = frameMedia.getId();
});
});
// Returns Active (Zoom) liveness resources
List<? extends ZoomLivenessResourceResponse> zoomLivenessResources = resources.getZoomLivenessResources();
for (ZoomLivenessResourceResponse liveness : zoomLivenessResources) {
// Get the liveness id
String livenessId = liveness.getId();
// Get the liveness facemap
FaceMapResponse facemap = liveness.getFaceMap();
// Get the liveness frames
List<? extends FrameResponse> frames = liveness.getFrames();
for (FrameResponse frame : frames) {
// Get the frame media
MediaResponse frameMedia = frame.getMedia();
// Get the frame media id
String frameMediaId = frameMedia.getId();
}
}
// Returns Active (Zoom) liveness resources
$zoomLivenessResources = $resources->getZoomLivenessResources();
foreach ($zoomLivenessResources as $liveness) {
// Get the liveness id
$livenessId = $liveness->getId();
// Get the liveness facemap
$facemap = liveness.getFaceMap();
// Get the liveness frames
$frames = liveness.getFrames();
foreach ($frames as $frame) {
// Get the frame media
$frameMedia = $frame->getMedia();
// Get the frame media id
$frameMediaId = $frameMedia->getId();
});
});
# Returns Active (Zoom) liveness resources
zoom_liveness_resources = resources.zoom_liveness_resources
for liveness in zoom_liveness_resources:
# Get the liveness id
liveness_id = liveness.id
# Get the liveness facemap
facemap = liveness.facemap
# Get the liveness frames
frames = liveness.frames
for frame in frames:
# Get the frame media
frame_media = frame.media
# Get the frame media id
frame_media_id = frame_media.id
// Returns Active (Zoom) liveness resources
List<ZoomLivenessResourceResponse> zoomLivenessResources = resources.ZoomLivenessResources;
foreach (ZoomLivenessResourceResponse liveness in zoomLivenessResources)
{
// Get the liveness id
string livenessId = liveness.Id;
// Get the liveness facemap
FaceMapResponse facemap = liveness.FaceMap;
// Get the liveness frames
List<FrameResponse> frames = liveness.Frames;
foreach (ZoomLivenessResourceResponse liveness in zoomLivenessResources)
{
// Get the frame media
MediaResponse frameMedia = frame.Media;
// Get the frame media id
String frameMediaId = frameMedia.Id;
}
}
// Returns Active (Zoom) liveness resources
zoomLivenessResources = resources.zoomLivenessResources
for _, liveness := range zoomLivenessResources {
// Get the liveness id
livenessId := liveness.ID
// Get the liveness facemap
facemap := liveness.FaceMap
// Get the liveness frames
frames := liveness.Frames
for _, frame := range frames {
// Get the frame media
frameMedia := frame.Media
// Get the frame media id
frameMediaId := frameMedia.ID
}
}
Retrieve user information
This is the full JSON version of the user's profile using document fields.
The document_fields media id should be used when an OCR or manual data entry result is successful. The media ID will be updated to the latest result, if you get OCR data back it will relate to the server side extraction. If the data entry goes for a manual check and data is extracted successfully the media ID will also be updated accordingly and point to generated media from a text data check.
The absence of the document fields object would indicate that data did not get extracted from the ID document.
idvClient.getMediaContent(sessionId, documentFieldsMediaId).then(media => {
const buffer = media.getContent();
const jsonData = JSON.parse(buffer);
// handle jsonData here
}).catch(error => {
// handle error
})
Media media = docScanClient.getMediaContent(sessionId, documentFieldsMediaId);
<?php
$media = $docScanClient->getMediaContent($sessionId, $documentFieldsMediaId);
$data = json_decode($media->getContent());
media = doc_scan_client.get_media_content(session_id, documentFieldsMediaId)
data = json.loads(media.content)
MediaValue media = docScanClient.GetMediaContent(sessionId, documentFieldsMediaId);
Example Extractions
{
"full_name": "ANGELA ZOE UK SPECIMEN",
"date_of_birth": "1988-12-04",
"nationality": "GBR",
"given_names": "ANGELA ZOE",
"family_name": "UK SPECIMEN",
"place_of_birth": "CROYDON",
"gender": "FEMALE",
"document_type": "PASSPORT",
"issuing_country": "GBR",
"document_number": "533028754",
"expiration_date": "2025-09-28",
"date_of_issue": "2015-09-28",
"issuing_authority": "HMPO",
"mrz": {
"type": 2,
"line1": "P<GBRUK<SPECIMEN<<ANGELA<ZOE<<<<<<<<<<<<<<<<",
"line2": "5330287549GBR8812049F2509286<<<<<<<<<<<<<<02"
},
"document_template": {
"front_page_name": "United Kingdom - ePassport (2015)"
}
}
{
"full_name": "STEVONNE ANNA MITCHELITE",
"date_of_birth": "1992-02-22",
"given_names": "STEVONNE ANNA",
"family_name": "MITCHELITE",
"place_of_birth": "UNITED KINGDOM",
"gender": "FEMALE",
"structured_postal_address": {
"address_format": 1,
"building_number": "244",
"address_line1": "244 MANNER ROAD",
"address_line2": "SONYMANE",
"address_line3": "SWANSEA",
"town_city": "SWANSEA",
"postal_code": "SA8 8JA",
"country_iso": "GBR",
"country": "United Kingdom",
"formatted_address": "244 MANNER ROAD, SONYMANE, SWANSEA,\nSA8 8JA"
},
"document_type": "DRIVING_LICENCE",
"issuing_country": "GBR",
"document_number": "MITCH952222SA8KK22",
"expiration_date": "2028-11-01",
"date_of_issue": "2021-11-02",
"issuing_authority": "DVLA",
"driving_licence_class": "AM/A/B1/B//p/q",
"driving_licence_restriction_code": "115",
"document_template": {
"front_page_name": "United Kingdom - Driving License (2021) #2",
"back_page_name": "United Kingdom - Driving License (2014-2021) Side B"
}
}
{
"full_name": "TECH REFRESH ICTHREEMALE",
"date_of_birth": "1990-08-01",
"nationality": "KEN",
"given_names": "TECH REFRESH",
"family_name": "ICTHREEMALE",
"place_of_birth": "NAIROBI",
"gender": "MALE",
"document_type": "RESIDENCE_PERMIT",
"issuing_country": "GBR",
"document_number": "RF9082242",
"expiration_date": "2015-11-11",
"date_of_issue": "2015-05-19",
"mrz": {
"type": 1,
"line1": "IRGBRRF90822427<<<<<<<<<<<<<<<",
"line2": "9008010M1511114KEN<<<<<<<<<<<8",
"line3": "ICTHREEMALE<<TECH<REFRESH<<<<<"
},
"place_of_issue": "UK"
}
{
"full_name": "Erika Mustermann",
"date_of_birth": "1964-08-12",
"given_names": "Erika",
"family_name": "Mustermann",
"place_of_birth": "Berlin",
"document_type": "DRIVING_LICENCE",
"issuing_country": "DEU",
"document_number": "Z021AB37X13",
"expiration_date": "2036-03-19",
"date_of_issue": "2021-03-20",
"place_of_issue": "Landratsamt\nMu sterhausen amSee"
}
{
"full_name": "CARMEN ESPANOLA ESPANOLA",
"date_of_birth": "1980-01-01",
"nationality": "ESP",
"given_names": "CARMEN",
"family_name": "ESPANOLA ESPANOLA",
"place_of_birth": "MADRID (MADRID)",
"gender": "FEMALE",
"document_type": "PASSPORT",
"issuing_country": "ESP",
"document_number": "ZAB000254",
"expiration_date": "2025-01-01",
"date_of_issue": "2015-01-01",
"issuing_authority": "DGP -28391A6PK",
"mrz": {
"type": 2,
"line1": "P<ESPESPANOLA<ESPANOLA<<CARMEN<<<<<<<<<<<<<<",
"line2": "ZAB0002549ESP8001014F2501017A9999999900<<<44"
},
"personal_identification_number": "A9999999900"
}
{
"full_name": "John Dee Doe",
"date_of_birth": "2003-10-27",
"given_names": "John Dee",
"first_name": "John",
"middle_name": "Dee",
"family_name": "Doe",
"gender": "MALE",
"weight": "140 lbs",
"height": "76 in",
"eye_color": "BLU",
"structured_postal_address": {
"address_format": 3,
"address_line1": "123 MAIN STREET APT. 1",
"town_city": "CARSON CITY",
"state": "NV",
"postal_code": "89701-0000",
"country_iso": "USA",
"country": "USA",
"formatted_address": "123 MAIN STREET APT. 1, CARSON CITY, NV, 897010000"
},
"document_type": "STATE_ID",
"issuing_country": "USA",
"document_number": "123456789012",
"expiration_date": "2028-10-27",
"date_of_issue": "2020-10-25",
"issuing_authority": "Nevada",
"driving_licence_class": "A",
"driving_licence_restriction_code": "NONE",
"driving_licence_endorsed": "NONE",
"document_template": {
"front_page_name": "United States - Nevada Id Card (2021) Real",
"back_page_name": "United States - Nevada Id Card (2021) Side B"
}
}
Good to know
Not all fields will be available all the time, as not all of them are mandatory.
Retrieve supplementary documents
Supplementary documents will be similarly available as part of the JSON if they have been successfully parsed by either OCR or manual data entry. When retrieving supplementary documents, any document images will appear as 'pages' objects in the JSON whilst uploaded pdfs will be 'file' objects.
idvClient.getMediaContent(sessionId, documentFieldsMediaId).then(media => {
const buffer = media.getContent();
const jsonData = JSON.parse(buffer);
// handle jsonData here
}).catch(error => {
// handle error
})
Media media = docScanClient.getMediaContent(sessionId, documentFieldsMediaId);
<?php
$media = $docScanClient->getMediaContent($sessionId, $documentFieldsMediaId);
$data = json_decode($media->getContent());
media = doc_scan_client.get_media_content(session_id, documentFieldsMediaId)
data = json.loads(media.content)
MediaValue media = docScanClient.GetMediaContent(sessionId, documentFieldsMediaId);
If you have enabled non latin characters Yoti will do its best to provide the latin characters where possible.
Example Extraction
All extractions for supplementary documents will carry the same JSON structure
{
"full_name": "ANNA GREEN",
"structured_postal_address": {
"address_format": 1,
"building_number": "50",
"street": "Mast House Terrace",
"address_line1": "50 Mast House Terrace",
"town_city": "London",
"state": "Greater London",
"postal_code": "E14 3RN",
"country_iso": "GBR",
"country": "United Kingdom",
"formatted_address": "50 Mast House Terrace\nE143RN London\nE14 3RN"
},
"date_of_issue": "2020-05-26",
"organisation": "Plusnet"
}
{
"full_name": "ROGER ROGERS",
"structured_postal_address": {
"address_format": 1,
"building_number": "60",
"street": "Mast House Terrace",
"address_line1": "60 Mast House Terrace",
"town_city": "London",
"state": "Greater London",
"postal_code": "E14 3RN",
"country_iso": "GBR",
"country": "United Kingdom",
"formatted_address": "60 Mast House Terrace\nE143RN London\nE14 3RN"
},
"date_of_issue": "2020-02-06",
"organisation": "Thames Water"
}
{
"full_name": "JOHN JONES",
"structured_postal_address": {
"address_format": 1,
"building_number": "50",
"street": "Mast House Terrace",
"address_line1": "50 Mast House Terrace",
"town_city": "London",
"state": "Greater London",
"postal_code": "E14 3RN",
"country_iso": "GBR",
"country": "United Kingdom",
"formatted_address": "50 Mast House Terrace\nE143RN London\nE14 3RN"
},
"date_of_issue": "2003-11-08",
"organisation": "First Bank of Wiki"
}
Address Formats
Addresses will be returned in 1 of 4 different formats.
{
"address_format": 1,
"building_number": "15a",
"address_line1": "15a North Street",
"town_city": "CARSHALTON",
"postal_code": "SM5 2HW",
"country_iso": "GBR",
"country": "UK",
"formatted_address": "15a North Street\nCARSHALTON\nSM5 2HW\nUK"
}
{
"address_format": 2,
"care_of": "S/O: Vipen Kumar Aggarwal",
"building": "House No.86-A",
"street": "Rajguru Nagar",
"town_city": "Rajguru Nagar",
"subdistrict": "Ludhiana",
"district": "Ludhiana",
"state": "Punjab",
"postal_code": "141012",
"post_office": "Rajguru Nagar",
"country_iso": "IND",
"country": "India",
"formatted_address": "S/O: Vipen Kumar Aggarwal\nHouse No.86-A\nRajguru Nagar\nLudhiana\nPunjab\n141012\nIndia"
}
{
"address_format": 3,
"address_line1": "1512 Ferry Street",
"town_city": "Anniston",
"state": "AL",
"postal_code": "36201",
"country_iso": "USA",
"country": "USA",
"formatted_address": "1512 Ferry Street\nAnniston AL 36201\nUSA"
}
{
"address_format": 4,
"address_line1": "910 GOVERNMENT ST VICTORIA BC V8W 3Y8",
"country_iso": "CAN",
"country": "Canada",
"formatted_address": "910 GOVERNMENT ST VICTORIA BC V8W 3Y8"
}
Field name | Type | Description |
|---|---|---|
address_format | number | AddressFormat is used to identify which fields may be present in the JSON object. See table below that defines what format is used for each country. |
udprn | string | Udprn is the Unique Delivery Point Reference Number that identifies a property throughout its lifecycle. |
care_of | string | CareOf identifies the owner of the premises. |
sub_building | string | SubBuilding is used when the building is divided into smaller units (e.g. a block of flats) to identify the sub unit. |
building_number | string | BuildingNumber is the number of the building. |
building | string | Building is the name/number of the building. |
street | string | Street is the name/number of the street the building is on. |
landmark | string | Landmark is a description used to describe the location of the building. |
address_line1 | string | AddressLine1 is the first line of the address. |
address_line2 | string | AddressLine2 is the second line of the address. |
address_line3 | string | AddressLine3 is the third line of the address. |
address_line4 | string | AddressLine4 is the fourth line of the address. |
address_line5 | string | AddressLine5 is the fifth line of the address. |
address_line6 | string | AddressLine6 is the sixth line of the address. |
locality | string | Locality is the area the building is in. |
town_city | string | TownCity is the town/city/village/hamlet/community/etc. that the building is in. |
subdistrict | string | Subdistrict is the sub-district the building is in. |
district | string | District is the district the building is in. |
state | string | State is the state/county the building is in. |
postal_code | string | PostalCode is a code used by the country's postal service to aid in sorting and delivering mail (e.g. postcode, zipcode, pincode). |
post_office | string | PostOffice is the post office that serves the area the building is in. |
country_iso | string | CountryIso is the country the building is in. In ISO-3166-1 alpha-3 format. |
country | string | Country is the country the building is in. Localised. |
formatted_address | string | FormattedAddress is the full address in a single human readable string in a format that is suitable for printing onto an envelope. This field is not required when providing address information. |
The below defines the fields of the JSON structure used for all addresses. A subset of fields will be present in each case and address_format can be used to ascertain which ones for any given address. The country iso should not be used for this purpose.
Four address formats are available and detailed below:
Countries that use this format | GBR, JEY, IMN | IND | USA, AUS | All other countries |
address_format | 1 | 2 | 3 | 4 |
udprn | Optional | |||
care_of | Optional | |||
sub_building | Optional* | |||
building_number | Optional* | |||
building | Optional* | Optional | ||
street | Optional | |||
landmark | Optional | |||
address_line1 | Mandatory | Mandatory | Mandatory | |
address_line2 | Optional | Optional | Optional | |
address_line3 | Optional | Optional | ||
address_line4 | Optional | |||
address_line5 | Optional | |||
address_line6 | Optional | |||
locality | Optional | |||
town_city | Mandatory | Optional | Mandatory | |
subdistrict | Optional | |||
district | Optional | |||
state | Optional | Optional | Mandatory | |
postal_code | Mandatory | Mandatory | Mandatory | Optional |
post_office | Optional | |||
country_iso | Mandatory | Mandatory | Mandatory | Mandatory |
country | Mandatory | Mandatory | Mandatory | Mandatory |
formatted_address** | Mandatory | Mandatory | Mandatory | Mandatory |
** At least one must be present
*** Will always be returned in the data extraction, but is not mandatory when configuring an applicant profile
Last updated on
Was this page helpful?
Next to read:
Retrieve imagesGot a question? Contact us here.
Discard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message