How to use the App 

On this page you will find out how to generate IPA endpoint for your application. To integrate IPA in your app, please follow the steps below.

IPA endpoint generation schema

Let's generate endpoint 

IPA (Identity Proofing Application) is an application that allows you to verify that the identity claimed by the user corresponds to the identity supported by the provided documents.

In order to use IPA, you must generate an integration endpoint, which will be used to communicate with our servers. This integration endpoint is a secret and should not be shared with anyone.

1. Go to 'Configure your Access' 

Go to 'Configure your Access' page.

2. Fill out the form 

  1. Choose a tenant.

  2. Select a country and document type.

  3. After selecting the document, SOR will be displayed. Only some documents allow you to activate the functionality of System of Record Check. If this option is available for the selected document, the SOR field will be shown.

  4. Choose one of the possible liveness options:

    • none - document check without face verification
    • passive - (default) document check with comparison between the submitted self-portrait image and document’s portrait
    • active - document check with liveness challenge.

3. Submit form 

After form submission, an integration endpoint will be generated and presented on the summary page. This is your only opportunity to copy and preserve this secret url. You will not have access to the generated integration endpoint again after this step.

Afterwards you can:

  • Generate test QR code - scan the QR code and test document verification yourself. (You can check the verification details on our “Transactions” page.)
  • Configure again - start the configuration process again and generate a new integration endpoint.

Use generated endpoint in your app 

Integration endpoint should be used in your backend application and should not be exposed to the frontend. This endpoint is a secret, do not share it with anyone!

This sample code shows how integration endpoint can be used in backend application for short link / qr code generation. Replace the value of GENERATED_ENDPOINT_URL with your integration endpoint.

1// ES5
2const fetch = require('node-fetch');
3// ES6
4import fetch from 'node-fetch';
5
6interface IPAServiceResponse {
7 /**
8 * QR Code image containing a short link.
9 * The image is encoded in Base64.
10 *
11 * @example 'data:image/png;base64,iVBORw0KG....'
12 * @example
13 * ```tsx
14 * <img src={qrCode} alt="QR Code to IPA" />
15 * ```
16 */
17 qrCode: string;
18 /**
19 * A short link that starts an Identity Proofing for an end user.
20 *
21 * @example "https://ipvdemo.devportal.idemia.io/go/7ab19743"
22 */
23 shortLink: string;
24 /**
25 * Transaction identifier.
26 *
27 * @example "gipsa-69c35680-6657-5116-aac3-6c38b08c8683"
28 */
29 transactionId: string;
30}
31
32/**
33* Get short link, QR code and transaction identifier to IPV demo.
34*
35* @returns {IPAServiceResponse} Response from IPA generated endpoint
36*/
37const getIPAService = async (): Promise<IPAServiceResponse> => {
38 return await fetch('GENERATED_ENDPOINT_URL', {
39 headers: {
40 'Content-Type': 'application/json; charset=utf8',
41 },
42 method: 'GET',
43 }).then((response) => response.json<IPAServiceResponse>());
44};