Skip to main content
Version: Node.js

Quickstart

This guide will help you get started with the KYC Match API. You will learn how to initialize the SDK, send a KYC Match request, and handle the response.

Prerequisites​

Before you begin, you need to have the following:

Step 1: Get your API Credentials​

To get your API Credentials, you can go to the KYC Match Product Page and click on "Manage on Provider" to access the service dashboard. For a full guide on how to get your credentials, you can refer to the Registration guide.

Step 2: Create a new project​

Create a new folder and enter the folder from a terminal.

mkdir kyc-match-test
cd kyc-match-test

Step 3: Initialize the SDK​

npm init -y
npm install glide-sdk

Step 4: Send a KYC Match request​

Create a new file index.ts and initialize the SDK with your API credentials.

index.ts
import { GlideClient } from "glide-sdk";

async function main() {
    const glide = new GlideClient({
        clientId: "<YOUR_CLIENT_ID>",
        clientSecret: "<YOUR_CLIENT_SECRET>",
    });

    const kycMatchClient = await glide.kycMatch.forUser({phoneNumber: "+555123456789"});

    const matchResult = await kycMatchClient.match({
         phoneNumber: "+555123456789",
         idDocument: "66666666q",
         name: "Federica Sanchez Arjona",
         givenName: "Federica",
         familyName: "Sanchez Arjona",
         nameKanaHankaku: "federica",
         nameKanaZenkaku: "Ｆｅｄｅｒｉｃａ",
         middleNames: "Sanchez",
         familyNameAtBirth: "YYYY",
         address: "Tokyo-to Chiyoda-ku Iidabashi 3-10-10",
         streetName: "Nicolas Salmeron",
         streetNumber: 4,
         postalCode: 1028460,
         region: "Tokyo",
         locality: "ZZZZ",
         country: "Japan",
         houseNumberExtension: "VVVV",
         birthdate: "1978-08-22",
         email: "[email protected]",
         gender: "male"
     });
    console.log(matchResult);
}

main().catch(console.error);

To execute this you can run the following from a terminal in the directory of your code:

npx tsx index.ts