Retrieve user data

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();

      }

    });

​

    // 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

  });

// Returns a collection of liveness capture resources

const livenessCapture = resources.getLivenessCapture();

// 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 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();

    });

});

idvClient.getMediaContent(sessionId, documentFieldsMediaId).then(media => {

    const buffer = media.getContent();

    const jsonData = JSON.parse(buffer);

    // handle jsonData here

}).catch(error => {

    // handle error

})

{

    "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)"

    }

}

idvClient.getMediaContent(sessionId, documentFieldsMediaId).then(media => {

    const buffer = media.getContent();

    const jsonData = JSON.parse(buffer);

    // handle jsonData here

}).catch(error => {

    // handle error

})

{

    "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"

}

{

    "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"

}