@velocitycareerlabs/yoti-integration-plugin 1.25.0-dev-build.12642c864

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1 @@
+Copyright 2023 Velocity Team Authors

package/README.md

@@ -0,0 +1,4 @@
+# Introduction
+
+The package exposes the underlying Yoti dependency, as well as related
+functions used throughout the codebase

package/index.js

@@ -0,0 +1,10 @@
+/* eslint-disable global-require */
+const fetchers = require('./src/fetchers');
+
+module.exports = {
+  ...require('./src/yoti'),
+  ...require('./src/id-credential-types'),
+  ...require('./src/config/config'),
+  ...require('./src/init-plugin'),
+  fetchers,
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@velocitycareerlabs/yoti-integration-plugin",
+  "version": "1.25.0-dev-build.12642c864",
+  "description": "Library supporting integration with Yoti services",
+  "repository": "https://github.com/velocitycareerlabs/packages",
+  "main": "index.js",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest --config ./jest.config.js --runInBand --coverage",
+    "lint": "eslint . --format json >> eslint.json",
+    "lint:fix": "eslint --fix --ext .js ."
+  },
+  "dependencies": {
+    "@getyoti/sdk-sandbox": "1.7.0",
+    "@spencejs/spence-mongo-repos": "^0.10.2",
+    "@velocitycareerlabs/common-schemas": "1.25.0-dev-build.12642c864",
+    "@velocitycareerlabs/config": "1.25.0-dev-build.12642c864",
+    "@velocitycareerlabs/country-data": "1.25.0-dev-build.12642c864",
+    "@velocitycareerlabs/crypto": "1.25.0-dev-build.12642c864",
+    "@velocitycareerlabs/jwt": "1.25.0-dev-build.12642c864",
+    "@velocitycareerlabs/request": "1.25.0-dev-build.12642c864",
+    "env-var": "^7.0.0",
+    "http-errors": "2.0.0",
+    "lodash": "^4.17.21",
+    "mongodb": "~6.14.0",
+    "nanoid": "~3.3.1",
+    "uuid": "11.0.5",
+    "yoti": "4.10.0"
+  },
+  "devDependencies": {
+    "@spencejs/spence-factories": "0.10.2",
+    "@velocitycareerlabs/server-provider": "1.25.0-dev-build.12642c864",
+    "@velocitycareerlabs/tests-helpers": "1.25.0-dev-build.12642c864",
+    "eslint": "8.57.1",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "8.10.0",
+    "eslint-plugin-autofix": "1.1.0",
+    "eslint-plugin-better-mutation": "1.6.0",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-prefer-arrow-functions": "3.6.2",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-watch": "7.0.0",
+    "jest": "29.7.0",
+    "nock": "13.5.6",
+    "prettier": "2.8.8"
+  },
+  "gitHead": "ca5028aa212670198151cabf1147bacf59f10851"
+}

package/src/config/config.js

@@ -0,0 +1,21 @@
+const env = require('env-var');
+const { genericConfig } = require('@velocitycareerlabs/config');
+
+const { isTest } = genericConfig;
+
+const yotiConfig = {
+  bearerToken: env.get('BEARER_TOKEN').asString(),
+  yotiClientSdkId: env.get('YOTI_CLIENT_SDK_ID').required(!isTest).asString(),
+  yotiSecret: env.get('YOTI_SECRET').required().asString(),
+  idVerificationTenantId: env
+    .get('ID_VERIFICATION_TENANT_ID')
+    .required()
+    .asString(),
+  yotiNotificationsWebhookRelativePath: '/yoti-integration/notifications',
+  yotiSessionTtl: 2629800, // seconds
+  yotiResourceRetentionTtl: 5259600, // 315576000 for creating long lived session for CI
+};
+
+module.exports = {
+  yotiConfig,
+};

package/src/controllers/id-verify/controller.js

@@ -0,0 +1,341 @@
+const { nanoid } = require('nanoid');
+const { generateCredentialJwt } = require('@velocitycareerlabs/jwt');
+const { generateKeyPair } = require('@velocitycareerlabs/crypto');
+const {
+  flow,
+  map,
+  filter,
+  defaultTo,
+  isEmpty,
+  split,
+  last,
+} = require('lodash/fp');
+const newError = require('http-errors');
+const { IDVClient } = require('yoti');
+
+const {
+  identifyWebhookRequestBodySchema,
+  verificationIdentifyResponse200Schema,
+} = require('@velocitycareerlabs/common-schemas');
+const {
+  createSessionSpec,
+  isCountryCodeValid,
+  getIdDocument,
+  yotiCheckTointernalYotiCheck,
+} = require('../../yoti');
+const {
+  submitCompleteOfferExchange,
+  submitAddOfferToExchange,
+} = require('../../fetchers');
+
+const idVerificationController = async (fastify) => {
+  const { config } = fastify;
+
+  const idvClient = new IDVClient(config.yotiClientSdkId, config.yotiSecret);
+
+  fastify.addSchema(identifyWebhookRequestBodySchema);
+  fastify.addSchema(verificationIdentifyResponse200Schema);
+
+  fastify.post(
+    '/start-session',
+    {
+      schema: fastify.autoSchema({
+        body: {
+          type: 'object',
+          properties: {
+            defaultCountryCode: { type: 'string' },
+          },
+          required: ['defaultCountryCode'],
+          additionalProperties: false,
+        },
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              sessionId: { type: 'string' },
+              sessionToken: { type: 'string' },
+              verifierAuthToken: { type: 'string' },
+              verificationIdentifier: { type: 'string' },
+            },
+            required: [
+              'sessionId',
+              'sessionToken',
+              'verifierAuthToken',
+              'verificationIdentifier',
+            ],
+          },
+        },
+      }),
+    },
+    async (req) => {
+      const { repos, body } = req;
+      const { defaultCountryCode: countryCode } = body;
+
+      if (!(await isCountryCodeValid(countryCode))) {
+        return newError(400, 'Unsupported Country');
+      }
+      const verifierAuthToken = nanoid();
+      const sessionSpec = createSessionSpec(
+        { verifierAuthToken, countryCode },
+        req
+      );
+      const session = await idvClient.createSession(sessionSpec);
+      const sessionId = session.getSessionId();
+      const sessionToken = session.getClientSessionToken();
+      const verificationIdentifier = nanoid();
+
+      const { privateKey } = generateKeyPair();
+
+      const verificationIdentifierContent = await generateCredentialJwt(
+        {
+          id: verificationIdentifier,
+          type: ['VerificationIdentifier'],
+          issuer: fastify.config.rootDid,
+          credentialSubject: {
+            id: sessionId,
+          },
+        },
+        privateKey
+      );
+      await repos.verificationSessions.insert({
+        sessionId,
+        verifierAuthToken,
+        countryCode,
+        verificationIdentifierContent,
+      });
+      return {
+        sessionId,
+        sessionToken,
+        verifierAuthToken,
+        verificationIdentifier: verificationIdentifierContent,
+      };
+    }
+  );
+
+  fastify.post(
+    config.yotiNotificationsWebhookRelativePath,
+    {
+      schema: fastify.autoSchema({
+        headers: {
+          type: 'object',
+          properties: {
+            authorization: { type: 'string' },
+          },
+          required: ['authorization'],
+        },
+        body: {
+          type: 'object',
+          properties: {
+            session_id: {
+              type: 'string',
+            },
+            topic: {
+              type: 'string',
+              const: 'session_completion',
+            },
+          },
+          required: ['session_id', 'topic'],
+          additionalProperties: true,
+        },
+        response: {
+          200: {
+            type: 'object',
+          },
+          ...fastify.NotFoundResponse,
+          ...fastify.UnauthorizedResponse,
+        },
+      }),
+    },
+    async (req) => {
+      const { repos, body, headers } = req;
+      const { session_id: sessionId } = body;
+      const { authorization } = headers;
+
+      const verificationSession = await repos.verificationSessions.findOne({
+        filter: { sessionId },
+      });
+      if (!verificationSession) {
+        return newError(404, `Session Id: ${sessionId} not found`);
+      }
+
+      const isAuthenticated =
+        flow(split(' '), last)(authorization) ===
+        verificationSession.verifierAuthToken;
+
+      if (!isAuthenticated) {
+        return newError(
+          401,
+          `Auth token: ${verificationSession.verifierAuthToken} invalid for session`
+        );
+      }
+      const offer = await getOffer({ verificationSession, sessionId }, req);
+      if (offer) {
+        try {
+          await submitAddOfferToExchange(
+            {
+              offer,
+              exchangeId: verificationSession.exchangeId,
+            },
+            req
+          );
+        } catch (e) {
+          req.log.warn({
+            err: e,
+            fn: 'submitAddOfferToExchange',
+            exchangeId: verificationSession.exchangeId,
+          });
+          throw e;
+        }
+      }
+      try {
+        await submitCompleteOfferExchange(
+          {
+            exchangeId: verificationSession.exchangeId,
+          },
+          req
+        );
+      } catch (e) {
+        req.log.warn({
+          err: e,
+          fn: 'submitCompleteOfferExchange',
+          exchangeId: verificationSession.exchangeId,
+        });
+        throw e;
+      }
+      return {};
+    }
+  );
+
+  fastify.post(
+    '/issuing/identify',
+    {
+      schema: fastify.autoSchema({
+        body: identifyWebhookRequestBodySchema,
+        response: {
+          200: verificationIdentifyResponse200Schema,
+          ...fastify.NotFoundResponse,
+        },
+      }),
+    },
+    async ({ body, repos }) => {
+      const { exchangeId } = body;
+      const id = getSessionId(body);
+
+      const updatedVerificationSessionDocuments =
+        await repos.verificationSessions.updateUsingFilter(
+          {
+            filter: { sessionId: id },
+          },
+          { exchangeId }
+        );
+
+      if (isEmpty(updatedVerificationSessionDocuments)) {
+        return newError.NotFound('Session not found');
+      }
+      const session = updatedVerificationSessionDocuments[0];
+
+      return { vendorUserId: session._id };
+    }
+  );
+
+  fastify.post(
+    '/issuing/generate-offers',
+    {
+      schema: fastify.autoSchema({
+        body: { type: 'object' },
+        response: { 202: { type: 'string' } },
+      }),
+    },
+    async (req, reply) => {
+      return reply.code(202).send('');
+    }
+  );
+
+  const getOffer = async ({ verificationSession, sessionId }, ctx) => {
+    try {
+      const session = await idvClient.getSession(sessionId);
+      const failedChecks = await getFailedChecksOfSession(session);
+
+      if (!isEmpty(failedChecks)) {
+        await addFailedChecksToVerificationSession(
+          verificationSession,
+          failedChecks,
+          ctx
+        );
+        return undefined;
+      }
+
+      const { credential: idDocument, credentialType } = await getIdDocument(
+        session,
+        idvClient
+      );
+
+      const credentialSubject = {
+        ...idDocument,
+        vendorUserId: verificationSession._id,
+      };
+      const idDocumentOffer = {
+        offerId: nanoid(),
+        type: [credentialType],
+        credentialSubject,
+        claimed: false,
+      };
+
+      ctx.log.info(idDocumentOffer);
+      return idDocumentOffer;
+    } catch (e) {
+      await addErrorToVerificationSession(verificationSession, e, ctx);
+    }
+    return undefined;
+  };
+};
+
+const getFailedChecksOfSession = async (session) => {
+  const checks = session.getChecks();
+  return flow([
+    filter((check) => check.getType() !== 'LIVENESS'),
+    filter((check) => {
+      const recommendation = check.getReport().getRecommendation();
+      return recommendation.value !== 'APPROVE';
+    }),
+    map((check) => {
+      const { value, reason } = check.getReport().getRecommendation();
+      const lastUpdated = check.getLastUpdated();
+      const id = check.getId();
+      return { id, value, reason: defaultTo('', reason), lastUpdated };
+    }),
+  ])(checks);
+};
+
+const addFailedChecksToVerificationSession = async (
+  verificationSession,
+  failedChecks,
+  { repos }
+) => {
+  const internalFailedChecks = map(yotiCheckTointernalYotiCheck, failedChecks);
+  await repos.verificationSessions.update(verificationSession._id, {
+    failedChecks: internalFailedChecks,
+  });
+};
+
+const getSessionId = ({ idDocumentCredentials, vendorOriginContext }) => {
+  if (vendorOriginContext) {
+    return vendorOriginContext;
+  }
+  const idDocumentCredential = idDocumentCredentials[0];
+  return idDocumentCredential.credentialSubject
+    ? idDocumentCredential.credentialSubject.id
+    : idDocumentCredential.id; // Deprecated
+};
+
+const addErrorToVerificationSession = async (
+  verificationSession,
+  err,
+  { repos }
+) => {
+  await repos.verificationSessions.update(verificationSession._id, {
+    err,
+  });
+};
+
+module.exports = idVerificationController;

package/src/controllers/id-verify/repo.js

@@ -0,0 +1,26 @@
+const {
+  repoFactory,
+  autoboxIdsExtension,
+} = require('@spencejs/spence-mongo-repos');
+
+module.exports = (app, options, next = () => {}) => {
+  next();
+  return repoFactory(
+    {
+      name: 'verificationSessions',
+      entityName: 'verificationSession',
+      defaultProjection: {
+        _id: 1,
+        sessionId: 1,
+        exchangeId: 1,
+        verifierAuthToken: 1,
+        countryCode: 1,
+        verificationIdentifierContent: 1,
+        createdAt: 1,
+        updatedAt: 1,
+      },
+      extensions: [autoboxIdsExtension],
+    },
+    app
+  );
+};

package/src/diagrams/README.md

@@ -0,0 +1,14 @@
+Yoti integration steps flow charts.  
+Tool used: https://mermaid-js.github.io/  
+Result Markdown can be used in documentation directly (renders automatically)  
+
+Part 1:  
+    Source: [diagram-source-part-1.md](diagram-source-part-1.md ':include')  
+    Result Markdown: [diagram-markdown-part-1.md](diagram-markdown-part-1.md ':include')
+
+Part 2:  
+    Source: [diagram-source-part-2.md](diagram-source-part-2.md ':include')  
+    Result Markdown: [diagram-markdown-part-2.md](diagram-markdown-part-1.md ':include')
+
+
+NB: Charts are used in [Wiki](https://velocitycareerlabs.visualstudio.com/velocity/_wiki/wikis/velocity.wiki/197/KYC-Integration), in case charts are modified, - Wiki page have to be updated as well

package/src/diagrams/diagram-markdown-part-1.md

@@ -0,0 +1 @@
+[![](https://mermaid.ink/img/eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5hdXRvbnVtYmVyXG5Ob3RlIGxlZnQgb2YgT3JnYW5pemF0aW9uIFNldHVwOiBQYXJ0IDE6IDxicj4gb3JnYW5pemF0aW9uIHJlZ2lzdHJhdGlvbjxicj4gYW5kIDxicj4gaXNzdWluZyB3ZWJob29rc1xuT3JnYW5pemF0aW9uIFNldHVwLT4-VmVsb2NpdHkgUmVnaXN0YXI6IFJlZ2lzdGVyIE9yZ2FuaXphdGlvblxuT3JnYW5pemF0aW9uIFNldHVwLT4-Q3JlZGVudGlhbCBBZ2VudDogQWRkIGEgVGVuYW50ICh0aGF0IGNvcnJlc3BvbmRzIHRvIHRoYXQgT3JnYW5pemF0aW9uKVxuTm90ZSBsZWZ0IG9mIFlvdGkgSW50ZWdyYXRpb24gU2VydmVyOiBJbXBsZW1lbnQgdGhlIDxicj4yIGlzc3Vpbmcgd2ViaG9va3MgXG5Zb3RpIEludGVncmF0aW9uIFNlcnZlci0tPj5Zb3RpIEludGVncmF0aW9uIFNlcnZlcjogV2ViaG9vayA8YnI-Wy9pc3N1aW5nL2lkZW50aWZ5XVxuWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXItLT4-WW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IFdlYmhvb2sgPGJyPlsvaXNzdWluZy9nZW5lcmF0ZS1vZmZlcnNdXG5cblxuIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifSwidXBkYXRlRWRpdG9yIjpmYWxzZSwiYXV0b1N5bmMiOnRydWUsInVwZGF0ZURpYWdyYW0iOnRydWV9)](https://mermaid-js.github.io/mermaid-live-editor/edit/##eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5hdXRvbnVtYmVyXG5Ob3RlIGxlZnQgb2YgT3JnYW5pemF0aW9uIFNldHVwOiBQYXJ0IDE6IDxicj4gb3JnYW5pemF0aW9uIHJlZ2lzdHJhdGlvbjxicj4gYW5kIDxicj4gaXNzdWluZyB3ZWJob29rc1xuT3JnYW5pemF0aW9uIFNldHVwLT4-VmVsb2NpdHkgUmVnaXN0YXI6IFJlZ2lzdGVyIE9yZ2FuaXphdGlvblxuT3JnYW5pemF0aW9uIFNldHVwLT4-Q3JlZGVudGlhbCBBZ2VudDogQWRkIGEgVGVuYW50ICh0aGF0IGNvcnJlc3BvbmRzIHRvIHRoYXQgT3JnYW5pemF0aW9uKVxuTm90ZSBsZWZ0IG9mIFlvdGkgSW50ZWdyYXRpb24gU2VydmVyOiBJbXBsZW1lbnQgdGhlIDxicj4yIGlzc3Vpbmcgd2ViaG9va3MgXG5Zb3RpIEludGVncmF0aW9uIFNlcnZlci0tPj5Zb3RpIEludGVncmF0aW9uIFNlcnZlcjogV2ViaG9vayA8YnI-Wy9pc3N1aW5nL2lkZW50aWZ5XVxuWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXItLT4-WW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IFdlYmhvb2sgPGJyPlsvaXNzdWluZy9nZW5lcmF0ZS1vZmZlcnNdXG5cblxuIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjpmYWxzZX0)

package/src/diagrams/diagram-markdown-part-2.md

@@ -0,0 +1 @@
+[![](https://mermaid.ink/img/eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5hdXRvbnVtYmVyXG5wYXJ0aWNpcGFudCBIb2xkZXIgQXBwXG5wYXJ0aWNpcGFudCBDcmVkZW50aWFsIEFnZW50XG5Ob3RlIGxlZnQgb2YgSG9sZGVyIEFwcDogUGFydCAyOiA8YnI-IEhvbGRlciBBcHAgPGJyPiBZb3RpIEtZQyBpc3N1aW5nIGZsb3dcbkhvbGRlciBBcHAgLS0-PiBIb2xkZXIgQXBwIDogVXNlciBzdGFydHMgdGhlPGJyPiBZb3RpIEtZQyBwcm9jZXNzXG5Ib2xkZXIgQXBwIC0-PiBZb3RpIEludGVncmF0aW9uIFNlcnZlciA6IGNhbGwgZW5kcG9pbnQ6IFsvc3RhcnQtc2Vzc2lvbl1cbllvdGkgSW50ZWdyYXRpb24gU2VydmVyIC0-PiBZb3RpJ3MgU2VydmljZXMgOiBbL3N0YXJ0LXNlc3Npb25dXG5Ib2xkZXIgQXBwIC0-PiBDcmVkZW50aWFsIEFnZW50OiBjYWxsIGlkZW50aWZ5IGVuZHBvaW50OiA8YnI-IFsvYXBpL2hvbGRlci92MC42L29yZy97e2RpZH19L2V4Y2hhbmdlXSA8YnI-IGNyZWF0ZXMgYW4gZXhjaGFuZ2UgZG9jdW1lbnQgPGJyPiBpbiBtb25nbyBEQlxuSG9sZGVyIEFwcCAtPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgZW5kcG9pbnQ6IFsvaXNzdWluZy9pZGVudGlmeV0gPGJyPiBhc3NvY2lhdGVzIHRoZSBZb3RpIHNlc3Npb24gPGJyPiB3aXRoIHRoZSBleGNoYW5nZVxuSG9sZGVyIEFwcCAtPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgZW5kcG9pbnQ6IFsvaXNzdWluZy9nZW5lcmF0ZS1vZmZlcnNdXG5DcmVkZW50aWFsIEFnZW50IC0tPj4gSG9sZGVyIEFwcDogcmVzcG9uZHMgd2l0aCBhIGNvZGU6IDIwMiA8YnI-IG1lYW5pbmcgLSByZXF1ZXN0IGFjY2VwdGVkLCA8YnI-IGV4Y2hhbmdlIHdpbGwgYmUgY29tcGxldGVkIGF0IDxicj4gYSBsYXRlciBwb2ludCBpbiB0aW1lIHZpYSBhIHB1c2g7XG5Ib2xkZXIgQXBwIC0tPj4gSG9sZGVyIEFwcCA6IFVzZXIgY29tcGxldGVzIHRoZTxicj4gWW90aSBLWUMgcHJvY2Vzc1xuWW90aSdzIFNlcnZpY2VzIC0tPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgYmFjayBhYm91dDxicj4gcHJvY2VzcyBjb21wbGV0ZVxuWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXIgLT4-IENyZWRlbnRpYWwgQWdlbnQ6IGFkZHMgYW4gb2ZmZXIgPGJyPiB0byB0aGUgZXhjaGFuZ2VcbllvdGkgSW50ZWdyYXRpb24gU2VydmVyIC0-PiBDcmVkZW50aWFsIEFnZW50OiBpbmZvcm1zIHRoYXQgdGhlIGV4Y2hhbmdlIDxicj5zaG91bGQgYmUgbWFya2VkIGFzIGNvbXBsZXRlXG5DcmVkZW50aWFsIEFnZW50IC0-PiBIb2xkZXIgQXBwOiBwdXNoIG5vdGlmaWVzIHRoZSBhcHBcbkhvbGRlciBBcHAgLS0-PiBIb2xkZXIgQXBwOiBwcm9jZXNzIGNvbXBsZXRlZFxuXG5cbiIsIm1lcm1haWQiOnsidGhlbWUiOiJkZWZhdWx0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ)](https://mermaid-js.github.io/mermaid-live-editor/beta/edit/##eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5hdXRvbnVtYmVyXG5wYXJ0aWNpcGFudCBIb2xkZXIgQXBwXG5wYXJ0aWNpcGFudCBDcmVkZW50aWFsIEFnZW50XG5Ob3RlIGxlZnQgb2YgSG9sZGVyIEFwcDogUGFydCAyOiA8YnI-IEhvbGRlciBBcHAgPGJyPiBZb3RpIEtZQyBpc3N1aW5nIGZsb3dcbkhvbGRlciBBcHAgLS0-PiBIb2xkZXIgQXBwIDogVXNlciBzdGFydHMgdGhlPGJyPiBZb3RpIEtZQyBwcm9jZXNzXG5Ib2xkZXIgQXBwIC0-PiBZb3RpIEludGVncmF0aW9uIFNlcnZlciA6IGNhbGwgZW5kcG9pbnQ6IFsvc3RhcnQtc2Vzc2lvbl1cbllvdGkgSW50ZWdyYXRpb24gU2VydmVyIC0-PiBZb3RpJ3MgU2VydmljZXMgOiBbL3N0YXJ0LXNlc3Npb25dXG5Ib2xkZXIgQXBwIC0-PiBDcmVkZW50aWFsIEFnZW50OiBjYWxsIGlkZW50aWZ5IGVuZHBvaW50OiA8YnI-IFsvYXBpL2hvbGRlci92MC42L29yZy97e2RpZH19L2V4Y2hhbmdlXSA8YnI-IGNyZWF0ZXMgYW4gZXhjaGFuZ2UgZG9jdW1lbnQgPGJyPiBpbiBtb25nbyBEQlxuSG9sZGVyIEFwcCAtPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgZW5kcG9pbnQ6IFsvaXNzdWluZy9pZGVudGlmeV0gPGJyPiBhc3NvY2lhdGVzIHRoZSBZb3RpIHNlc3Npb24gPGJyPiB3aXRoIHRoZSBleGNoYW5nZVxuSG9sZGVyIEFwcCAtPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgZW5kcG9pbnQ6IFsvaXNzdWluZy9nZW5lcmF0ZS1vZmZlcnNdXG5DcmVkZW50aWFsIEFnZW50IC0tPj4gSG9sZGVyIEFwcDogcmVzcG9uZHMgd2l0aCBhIGNvZGU6IDIwMiA8YnI-IG1lYW5pbmcgLSByZXF1ZXN0IGFjY2VwdGVkLCA8YnI-IGV4Y2hhbmdlIHdpbGwgYmUgY29tcGxldGVkIGF0IDxicj4gYSBsYXRlciBwb2ludCBpbiB0aW1lIHZpYSBhIHB1c2g7XG5Ib2xkZXIgQXBwIC0tPj4gSG9sZGVyIEFwcCA6IFVzZXIgY29tcGxldGVzIHRoZTxicj4gWW90aSBLWUMgcHJvY2Vzc1xuWW90aSdzIFNlcnZpY2VzIC0tPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgYmFjayBhYm91dDxicj4gcHJvY2VzcyBjb21wbGV0ZVxuWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXIgLT4-IENyZWRlbnRpYWwgQWdlbnQ6IGFkZHMgYW4gb2ZmZXIgPGJyPiB0byB0aGUgZXhjaGFuZ2VcbllvdGkgSW50ZWdyYXRpb24gU2VydmVyIC0-PiBDcmVkZW50aWFsIEFnZW50OiBpbmZvcm1zIHRoYXQgdGhlIGV4Y2hhbmdlIDxicj5zaG91bGQgYmUgbWFya2VkIGFzIGNvbXBsZXRlXG5DcmVkZW50aWFsIEFnZW50IC0-PiBIb2xkZXIgQXBwOiBwdXNoIG5vdGlmaWVzIHRoZSBhcHBcbkhvbGRlciBBcHAgLS0-PiBIb2xkZXIgQXBwOiBwcm9jZXNzIGNvbXBsZXRlZFxuXG5cbiIsIm1lcm1haWQiOiJ7XG4gIFwidGhlbWVcIjogXCJkZWZhdWx0XCJcbn0iLCJ1cGRhdGVFZGl0b3IiOmZhbHNlLCJhdXRvU3luYyI6dHJ1ZSwidXBkYXRlRGlhZ3JhbSI6ZmFsc2V9)

package/src/diagrams/diagram-source-part-1.md

@@ -0,0 +1,12 @@
+Online editor:
+    https://mermaid-js.github.io/mermaid-live-editor/edit/#eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5hdXRvbnVtYmVyXG5Ob3RlIGxlZnQgb2YgT3JnYW5pemF0aW9uIFNldHVwOiBQYXJ0IDE6IDxicj4gb3JnYW5pemF0aW9uIHJlZ2lzdHJhdGlvbjxicj4gYW5kIDxicj4gaXNzdWluZyB3ZWJob29rc1xuT3JnYW5pemF0aW9uIFNldHVwLT4-VmVsb2NpdHkgUmVnaXN0YXI6IFJlZ2lzdGVyIE9yZ2FuaXphdGlvblxuT3JnYW5pemF0aW9uIFNldHVwLT4-Q3JlZGVudGlhbCBBZ2VudDogQWRkIGEgVGVuYW50ICh0aGF0IGNvcnJlc3BvbmRzIHRvIHRoYXQgT3JnYW5pemF0aW9uKVxuTm90ZSBsZWZ0IG9mIFlvdGkgSW50ZWdyYXRpb24gU2VydmVyOiBJbXBsZW1lbnQgdGhlIDxicj4yIGlzc3Vpbmcgd2ViaG9va3MgXG5Zb3RpIEludGVncmF0aW9uIFNlcnZlci0tPj5Zb3RpIEludGVncmF0aW9uIFNlcnZlcjogV2ViaG9vayA8YnI-Wy9pc3N1aW5nL2lkZW50aWZ5XVxuWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXItLT4-WW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IFdlYmhvb2sgPGJyPlsvaXNzdWluZy9nZW5lcmF0ZS1vZmZlcnNdXG5cblxuIiwibWVybWFpZCI6IntcbiAgXCJ0aGVtZVwiOiBcImRlZmF1bHRcIlxufSIsInVwZGF0ZUVkaXRvciI6ZmFsc2UsImF1dG9TeW5jIjp0cnVlLCJ1cGRhdGVEaWFncmFtIjp0cnVlfQ
+
+Chart source:
+sequenceDiagram
+autonumber
+Note left of Organization Setup: Part 1: <br> organization registration<br> and <br> issuing webhooks
+Organization Setup->>Velocity Registar: Register Organization
+Organization Setup->>Credential Agent: Add a Tenant (that corresponds to that Organization)
+Note left of Yoti Integration Server: Implement the <br>2 issuing webhooks
+Yoti Integration Server-->>Yoti Integration Server: Webhook <br>[/issuing/identify]
+Yoti Integration Server-->>Yoti Integration Server: Webhook <br>[/issuing/generate-offers]

package/src/diagrams/diagram-source-part-2.md

@@ -0,0 +1,22 @@
+Online editor:
+https://mermaid-js.github.io/mermaid-live-editor/beta/edit/#eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5hdXRvbnVtYmVyXG5wYXJ0aWNpcGFudCBIb2xkZXIgQXBwXG5wYXJ0aWNpcGFudCBDcmVkZW50aWFsIEFnZW50XG5Ob3RlIGxlZnQgb2YgSG9sZGVyIEFwcDogUGFydCAyOiA8YnI-IEhvbGRlciBBcHAgPGJyPiBZb3RpIEtZQyBpc3N1aW5nIGZsb3dcbkhvbGRlciBBcHAgLS0-PiBIb2xkZXIgQXBwIDogVXNlciBzdGFydHMgdGhlPGJyPiBZb3RpIEtZQyBwcm9jZXNzXG5Ib2xkZXIgQXBwIC0-PiBZb3RpIEludGVncmF0aW9uIFNlcnZlciA6IGNhbGwgZW5kcG9pbnQ6IFsvc3RhcnQtc2Vzc2lvbl1cbllvdGkgSW50ZWdyYXRpb24gU2VydmVyIC0-PiBZb3RpJ3MgU2VydmljZXMgOiBbL3N0YXJ0LXNlc3Npb25dXG5Ib2xkZXIgQXBwIC0-PiBDcmVkZW50aWFsIEFnZW50OiBjYWxsIGlkZW50aWZ5IGVuZHBvaW50OiA8YnI-IFsvYXBpL2hvbGRlci92MC42L29yZy97e2RpZH19L2V4Y2hhbmdlXSA8YnI-IGNyZWF0ZXMgYW4gZXhjaGFuZ2UgZG9jdW1lbnQgPGJyPiBpbiBtb25nbyBEQlxuSG9sZGVyIEFwcCAtPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgZW5kcG9pbnQ6IFsvaXNzdWluZy9pZGVudGlmeV0gPGJyPiBhc3NvY2lhdGVzIHRoZSBZb3RpIHNlc3Npb24gPGJyPiB3aXRoIHRoZSBleGNoYW5nZVxuSG9sZGVyIEFwcCAtPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgZW5kcG9pbnQ6IFsvaXNzdWluZy9nZW5lcmF0ZS1vZmZlcnNdXG5DcmVkZW50aWFsIEFnZW50IC0tPj4gSG9sZGVyIEFwcDogcmVzcG9uZHMgd2l0aCBhIGNvZGU6IDIwMiA8YnI-IG1lYW5pbmcgLSByZXF1ZXN0IGFjY2VwdGVkLCA8YnI-IGV4Y2hhbmdlIHdpbGwgYmUgY29tcGxldGVkIGF0IDxicj4gYSBsYXRlciBwb2ludCBpbiB0aW1lIHZpYSBhIHB1c2g7XG5Ib2xkZXIgQXBwIC0tPj4gSG9sZGVyIEFwcCA6IFVzZXIgY29tcGxldGVzIHRoZTxicj4gWW90aSBLWUMgcHJvY2Vzc1xuWW90aSdzIFNlcnZpY2VzIC0tPj4gWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXI6IGNhbGwgYmFjayBhYm91dDxicj4gcHJvY2VzcyBjb21wbGV0ZVxuWW90aSBJbnRlZ3JhdGlvbiBTZXJ2ZXIgLT4-IENyZWRlbnRpYWwgQWdlbnQ6IGFkZHMgYW4gb2ZmZXIgPGJyPiB0byB0aGUgZXhjaGFuZ2VcbllvdGkgSW50ZWdyYXRpb24gU2VydmVyIC0-PiBDcmVkZW50aWFsIEFnZW50OiBpbmZvcm1zIHRoYXQgdGhlIGV4Y2hhbmdlIDxicj5zaG91bGQgYmUgbWFya2VkIGFzIGNvbXBsZXRlXG5DcmVkZW50aWFsIEFnZW50IC0-PiBIb2xkZXIgQXBwOiBwdXNoIG5vdGlmaWVzIHRoZSBhcHBcbkhvbGRlciBBcHAgLS0-PiBIb2xkZXIgQXBwOiBwcm9jZXNzIGNvbXBsZXRlZFxuXG5cbiIsIm1lcm1haWQiOiJ7XG4gIFwidGhlbWVcIjogXCJkZWZhdWx0XCJcbn0iLCJ1cGRhdGVFZGl0b3IiOmZhbHNlLCJhdXRvU3luYyI6dHJ1ZSwidXBkYXRlRGlhZ3JhbSI6ZmFsc2V9
+
+Chart source:
+sequenceDiagram
+autonumber
+participant Holder App
+participant Credential Agent
+Note left of Holder App: Part 2: <br> Holder App <br> Yoti KYC issuing flow
+Holder App -->> Holder App : User starts the<br> Yoti KYC process
+Holder App ->> Yoti Integration Server : call endpoint: [/start-session]
+Yoti Integration Server ->> Yoti's Services : [/start-session]
+Holder App ->> Credential Agent: call identify endpoint: <br> [/api/holder/v0.6/org/{{did}}/exchange] <br> creates an exchange document <br> in mongo DB
+Holder App ->> Yoti Integration Server: call endpoint: [/issuing/identify] <br> associates the Yoti session <br> with the exchange
+Holder App ->> Yoti Integration Server: call endpoint: [/issuing/generate-offers]
+Credential Agent -->> Holder App: responds with a code: 202 <br> meaning - request accepted, <br> exchange will be completed at <br> a later point in time via a push;
+Holder App -->> Holder App : User completes the<br> Yoti KYC process
+Yoti's Services -->> Yoti Integration Server: call back about<br> process complete
+Yoti Integration Server ->> Credential Agent: adds an offer <br> to the exchange
+Yoti Integration Server ->> Credential Agent: informs that the exchange <br>should be marked as complete
+Credential Agent ->> Holder App: push notifies the app
+Holder App -->> Holder App: process completed

package/src/fetchers.js

@@ -0,0 +1,23 @@
+const submitAddOfferToExchange = (
+  { offer, exchangeId },
+  { agentFetch, config }
+) =>
+  agentFetch
+    .post(
+      `operator-api/v0.8/tenants/${config.idVerificationTenantId}/exchanges/${exchangeId}/offers`,
+      { json: offer }
+    )
+    .json();
+
+const submitCompleteOfferExchange = ({ exchangeId }, { agentFetch, config }) =>
+  agentFetch
+    .post(
+      `operator-api/v0.8/tenants/${config.idVerificationTenantId}/exchanges/${exchangeId}/offers/complete`,
+      { json: { exchangeId } }
+    )
+    .json();
+
+module.exports = {
+  submitAddOfferToExchange,
+  submitCompleteOfferExchange,
+};

package/src/id-credential-types.js

@@ -0,0 +1,9 @@
+const IdCredentialTypes = Object.freeze({
+  DocumentVerification: 'IdDocument',
+  IdDocumentV1v0: 'IdDocumentV1.0',
+  DriversLicenseV1v0: 'DriversLicenseV1.0',
+  NationalIdV1v0: 'NationalIdCardV1.0',
+  PassportV1v0: 'PassportV1.0',
+});
+
+module.exports = { IdCredentialTypes };

package/src/init-plugin.js

@@ -0,0 +1,13 @@
+const idVerifyController = require('./controllers/id-verify/controller');
+const initVerificationSessionsRepo = require('./controllers/id-verify/repo');
+
+const yotiIntegrationPlugin = (server) => {
+  initVerificationSessionsRepo(server);
+  return server
+    .autoSchemaPreset({ tags: ['credential_issuer_id'] })
+    .register(idVerifyController, {
+      prefix: '/id-verify',
+    });
+};
+
+module.exports = { yotiIntegrationPlugin };

package/src/yoti.js

@@ -0,0 +1,273 @@
+const { omit, first, last, size } = require('lodash/fp');
+const { alpha3ToAlpha2 } = require('@velocitycareerlabs/country-data');
+
+const {
+  NotificationConfigBuilder,
+  SessionSpecificationBuilder,
+  RequestedDocumentAuthenticityCheckBuilder,
+  RequestedLivenessCheckBuilder,
+  RequestedTextExtractionTaskBuilder,
+  RequestedFaceMatchCheckBuilder,
+  SdkConfigBuilder,
+} = require('yoti');
+
+const { IdCredentialTypes } = require('./id-credential-types');
+
+const validCountryCodes = {
+  USA: true, // US
+  GBR: true, // UK
+  ISR: true, // Israel
+  AUT: true, // Austria
+  BEL: true, // Belgium
+  BGR: true, // Bulgaria
+  HRV: true, // Croatia
+  CYP: true, // Cyprus
+  CZE: true, // Czechia
+  DNK: true, // Denmark
+  EST: true, // Estonia
+  FIN: true, // Finland
+  FRA: true, // France
+  DEU: true, // Germany
+  GRC: true, // Greece
+  HUN: true, // Hungary
+  IRL: true, // Ireland
+  ITA: true, // Italy
+  LVA: true, // Latvia
+  LTU: true, // Lithuania
+  LUX: true, // Luxembourg
+  MLT: true, // Malta
+  NLD: true, // Netherlands
+  POL: true, // Poland
+  PRT: true, // Portugal
+  ROU: true, // Romania
+  SVK: true, // Slovakia
+  SVN: true, // Slovenia
+  ESP: true, // Spain
+  SWE: true, // Sweden
+};
+
+const YotiDocumentTypes = {
+  PASSPORT: 'PASSPORT',
+  DRIVING_LICENSE: 'DRIVING_LICENCE',
+  NATIONAL_ID: 'NATIONAL_ID',
+};
+
+const isCountryCodeValid = async (countryCode) => {
+  // const supportedCountries = await idvClient.getSupportedCountries();
+  return !!validCountryCodes[countryCode];
+};
+
+const fullNameToNameComponents = (fullNameStr) => {
+  const middleNames = [];
+  const nameParts = fullNameStr.split(' ');
+  const givenName = nameParts.slice(0, -1).join(' ');
+  const len = size(nameParts);
+  const firstName = len ? first(nameParts) : '';
+  const lastName = len ? last(nameParts) : '';
+  return { firstName, lastName, middleNames, givenName };
+};
+
+const buildYotiNotificationEndpoint = ({ config }) => {
+  const { hostUrl, yotiNotificationsWebhookRelativePath, isTest } = config;
+  const idVerifyPrefix = '/id-verify';
+  const urlObj = new URL(
+    `${hostUrl}${idVerifyPrefix}${yotiNotificationsWebhookRelativePath}`
+  );
+  if (isTest) {
+    // eslint-disable-next-line better-mutation/no-mutation
+    urlObj.protocol = 'https';
+  }
+  return urlObj.href;
+};
+
+const yotiCheckTointernalYotiCheck = (check) => {
+  return { ...omit(['id'], check), yotiId: check.id };
+};
+
+const getIdDocument = async (session, idvClient) => {
+  const resources = session.getResources();
+  const yotiDocuments = resources.getIdDocuments();
+  return yotiDocumentToIdDocument(session, first(yotiDocuments), idvClient);
+};
+
+const yotiDocumentToIdDocument = async (session, yotiDocument, idvClient) => {
+  const documentType = yotiDocument.getDocumentType();
+  // const issuingCountry = yotiDocument.getIssuingCountry();
+  const documentFields = yotiDocument.getDocumentFields();
+  let documentFieldsMediaId = null;
+  if (documentFields) {
+    documentFieldsMediaId = documentFields.getMedia().getId();
+  }
+
+  const media = await idvClient.getMediaContent(
+    session.getSessionId(),
+    `${documentFieldsMediaId}`
+  );
+  const buffer = media.getContent();
+  return buildCredential(documentType, JSON.parse(buffer));
+};
+
+const buildPassportAuthority = (baseCredential) => {
+  if (baseCredential.authority == null) {
+    return {
+      authority: {
+        name: 'Passport',
+      },
+    };
+  }
+  if (baseCredential.authority.name === '-') {
+    return {
+      authority: {
+        ...baseCredential.authority,
+        name: 'Passport',
+      },
+    };
+  }
+  return {
+    authority: baseCredential.authority,
+  };
+};
+const buildCredential = (documentType, data) => {
+  const baseCredential = buildBaseCredential(data);
+  switch (documentType) {
+    case YotiDocumentTypes.PASSPORT:
+      return {
+        credential: {
+          documentCode: 'P',
+          ...baseCredential,
+          ...buildPassportAuthority(baseCredential),
+        },
+        credentialType: IdCredentialTypes.PassportV1v0,
+      };
+    case YotiDocumentTypes.NATIONAL_ID:
+      return {
+        credential: baseCredential,
+        credentialType: IdCredentialTypes.NationalIdV1v0,
+      };
+    case YotiDocumentTypes.DRIVING_LICENSE:
+      return {
+        credential: {
+          name: data.organisation,
+          ...baseCredential,
+        },
+        credentialType: IdCredentialTypes.DriversLicenseV1v0,
+      };
+    default:
+      return {
+        credential: {
+          documentType,
+          ...baseCredential,
+        },
+        credentialType: IdCredentialTypes.IdDocumentV1v0,
+      };
+  }
+};
+
+const valueOrFallBack = (value, fallback = '-') => value ?? fallback;
+const buildAuthority = (issuingAuthority, issuingCountry) => {
+  if (!issuingAuthority && !issuingCountry) {
+    return null;
+  }
+  if (issuingAuthority && !issuingCountry) {
+    return {
+      name: valueOrFallBack(issuingAuthority),
+    };
+  }
+  const twoLetterIssuingCountry = alpha3ToAlpha2(issuingCountry);
+  return {
+    name: valueOrFallBack(issuingAuthority),
+    place: {
+      addressCountry: valueOrFallBack(twoLetterIssuingCountry),
+    },
+  };
+};
+const buildBaseCredential = (data) => {
+  const {
+    full_name: fullName,
+    first_name: firstName,
+    middle_name: middleName,
+    family_name: familyName,
+    date_of_birth: dateOfBirth,
+    document_number: documentNumber,
+    issuing_country: issuingCountry,
+    issuing_authority: issuingAuthority,
+    date_of_issue: dateOfIssue,
+    expiration_date: expirationDate,
+  } = data;
+  const nameComponents = fullNameToNameComponents(fullName);
+  return {
+    identifier: documentNumber,
+    person: {
+      givenName: firstName || nameComponents.firstName,
+      middleName: middleName || nameComponents.middleName,
+      familyName: familyName || nameComponents.lastName,
+      birthDate: dateOfBirth,
+    },
+    validity: {
+      firstValidFrom: dateOfIssue,
+      validUntil: expirationDate,
+    },
+    authority: buildAuthority(issuingAuthority, issuingCountry),
+  };
+};
+
+const convertFromBasicAuth = (str) =>
+  Buffer.from(str, 'base64').toString('binary');
+
+const createSessionSpec = ({ verifierAuthToken, countryCode }, { config }) => {
+  // Document Authenticity Check
+  const documentAuthenticityCheck =
+    new RequestedDocumentAuthenticityCheckBuilder().build();
+
+  const livenessCheck = new RequestedLivenessCheckBuilder()
+    .forStaticLiveness()
+    .build();
+
+  const faceMatchCheck = new RequestedFaceMatchCheckBuilder()
+    .withManualCheckFallback()
+    .build();
+
+  const textExtractionTask = new RequestedTextExtractionTaskBuilder()
+    .withManualCheckFallback()
+    .build();
+
+  const sdkConfig = new SdkConfigBuilder()
+    .withAllowsCameraAndUpload()
+    .withPresetIssuingCountry(countryCode)
+    .build();
+
+  const notificationEndpoint = buildYotiNotificationEndpoint({ config });
+  const notificationConfig = new NotificationConfigBuilder()
+    .withEndpoint(notificationEndpoint)
+    .withAuthToken(verifierAuthToken)
+    .withAuthTypeBearer() // .forResourceUpdate()
+    // .forTaskCompletion()
+    // .forCheckCompletion()
+    .forSessionCompletion()
+    .build();
+
+  return (
+    new SessionSpecificationBuilder()
+      .withClientSessionTokenTtl(config.yotiSessionTtl)
+      .withResourcesTtl(config.yotiResourceRetentionTtl)
+      // .withUserTrackingId('some-user-tracking-id')
+      .withRequestedCheck(documentAuthenticityCheck)
+      .withRequestedCheck(livenessCheck)
+      .withRequestedCheck(faceMatchCheck)
+      .withRequestedTask(textExtractionTask)
+      .withSdkConfig(sdkConfig)
+      .withNotifications(notificationConfig)
+      .build()
+  );
+};
+
+module.exports = {
+  buildYotiNotificationEndpoint,
+  convertFromBasicAuth,
+  createSessionSpec,
+  fullNameToNameComponents,
+  getIdDocument,
+  isCountryCodeValid,
+  yotiCheckTointernalYotiCheck,
+  buildCredential,
+};