Skip to main content
Version: Python

Quickstart

This guide will help you get started with the KYC Match API using Python. 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:

  • subscribe to the KYC Match service, (guide here)
  • Python 3.7 or higher

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 directory for your project and set up a virtual environment:

mkdir kyc-match-test
cd kyc-match-test
python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate

Step 3: Install the SDK​

pip install glide-sdk

Step 4: Send a KYC Match request​

Create a new file main.py and initialize the SDK with your API credentials:

main.py
from glide_sdk import GlideClient
from glide_sdk.src.glide_sdk.services.kyc_match import KycMatchPayload
import asyncio

async def main():
    glide = GlideClient(
        client_id="<YOUR_CLIENT_ID>",
        client_secret="<YOUR_CLIENT_SECRET>"
    )

    kyc_match_client = await glide.kyc_match.for_user(
        phone_number="+555123456789"
    )

    payload = KycMatchPayload(
        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"
    )

    match_result = await kyc_match_client.match(payload)
    print(match_result)

if __name__ == "__main__":
    asyncio.run(main())

Replace <YOUR_CLIENT_ID> and <YOUR_CLIENT_SECRET> with your API credentials.

Run the script:

python main.py