UR Matcher SDK

Learn more about the UR Matcher SDK and how to use it to scan and match UR Codes.

Prerequisites

The following describes the prerequisites for the UR Matcher SDK.

• Windows, Linux, or Mac.
• Administrative privileges on your system.
• You will need to be familiar with the Command Line (Windows) or Terminal (Mac/Linux)
• Install jq.
• Install Node Package Manager (npm).
• Install Docker and Docker Compose.

If you are using Windows:

• Install Bash with WSL or Git Bash. 

If you are using an Apple Silicon Mac:

• If you are using an Apple Silicon Mac, verify that Rosetta is disabled in Your Docker Installation. In Your Docker Desktop, go to Settings > General > Virtual Machine Options > Use Rosetta for x86_64/amd64 emulation on Apple Silicon and ensure this setting is left unchecked.

Additional knowledge and access required:

• The UR Encoder SDK software will guide you to creating a Private/Public Key Pair that will be used to secure your UR Codes integration.  You are responsible for the Security of your own Private Keys. Click here for more information about Key Management Best Practices.
• You will be hosting your Public Key on your Website, which requires designating a Webmaster/Dev with permission to upload and serve files on your Website/Domain. Click here for more information about the UR Codes Public Key Distribution System.

Introduction

The UR Matcher SDK is used by Relying Parties, as well as Issuing Authorities, to scan and match UR Codes with an Issuing Authority's Public Key.

Important Note: UR Codes created with the UR Code Generator Demo are only intended for Testing & Demo Purposes. Even though these UR Codes are "validated" with FaceTec's Public Testing Key, the accuracy of the Metadata itself has not been confirmed by FaceTec.

The UR Matcher SDK uses the /set-ur-code-public-key-map API to specify the Public Keys that can be used to validate the UR Code's Digital Signature. When a UR Code is scanned, the URL from the UR Code is used to look up the Public Key(s) specified in the Public Key Map to try and validate the UR Code. To learn more, see the UR Code Public Key Map Guide.

In addition to its UR Code Verification APIs, the UR Matcher SDK also offers the 2D:2D Matching API. The 2D:2D Matching API (/match-2d-2d-urcode) can be used to match a 2D Image from a trusted source against the 2D Face Image that is encoded in a UR Code. For more information about 2D:2D Matching and the Match Levels returned, please see the UR Code 2D:2D Matching Guide.

The UR Matcher SDK does not generate or create UR Codes. If Your Team is an Issuing Authority and needs to generate UR Codes, then Your Team should use the UR Encoder SDK instead. To learn more, please see the UR Encoder SDK Guide.

Getting Started

Your Team can download the UR Matcher SDK via the Downloads Page.

After downloading the UR Matcher SDK, Your Team can begin to configure and deploy the UR Matcher SDK into Your System via the UR Matcher Setup Script (video below).

Testing with Postman

After installing and testing with the UR Matcher SDK using the setup scripts, you can use the UR Matcher SDK Postman Test Suite to perform additional testing with the UR Matcher APIs. The Postman Test Suites are available on the Downloads Page.