KYC Match Reference

The KYC Match client is scoped to a single user, so in order to interact with the KYC Match service, you need to create a KycMatchUserClient instance for the user you want to verify.

KycMatchUserClients are created using the KycMatchClient accessible from the GlideClient instance.

KycMatchClient Reference

Methods

1. for_user

Description: for_user creates a KycMatchUserClient instance for the specified user.

Syntax:

async def for_user(
    phone_number: str = None,
    ip_address: str = None,
    user_id: str = None
) -> KycMatchUserClient

Parameters:

Parameter	Type	Description
phone_number	str	The phone number of the user
ip_address	str	The IP address of the user
user_id	str	A custom user identifier

Only one of the parameters should be provided.

Returns:

• KycMatchUserClient: A client instance for the specified user.

Example:

from glide_sdk import GlideClient
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"
    )

asyncio.run(main())

KycMatchUserClient Reference

The KycMatchUserClient is used to interact with the KYC Match service for a specific user.

Methods

1. match

Description: match verifies if the provided KYC data matches with the user's information.

Syntax:

async def match(match_data: dict) -> dict

Parameters:

Parameter	Type	Description
match_data	dict	A dictionary containing the KYC data to match

MatchData Properties:

Property	Type	Description
idDocument	str	The ID document number
name	str	Full name
givenName	str	Given name
familyName	str	Family name
nameKanaHankaku	str	Name in Kana Hankaku
nameKanaZenkaku	str	Name in Kana Zenkaku
middleNames	str	Middle names
familyNameAtBirth	str	Family name at birth
address	str	Full address
streetName	str	Street name
streetNumber	int	Street number
postalCode	int	Postal code
region	str	Region
locality	str	Locality
country	str	Country
houseNumberExtension	str	House number extension
birthdate	str	Birthdate in ISO format (YYYY-MM-DD)
email	str	Email address
gender	str	Gender

Returns: A dictionary containing the match results with the following structure:

{
    "status": "success",
    "data": {
        "idDocumentMatch": str,  # "true", "false", or "not_available"
        "nameMatch": str,
        "givenNameMatch": str,
        "familyNameMatch": str,
        "nameKanaHankakuMatch": str,
        "nameKanaZenkakuMatch": str,
        "middleNamesMatch": str,
        "familyNameAtBirthMatch": str,
        "addressMatch": str,
        "streetNameMatch": str,
        "streetNumberMatch": str,
        "postalCodeMatch": str,
        "regionMatch": str,
        "localityMatch": str,
        "countryMatch": str,
        "houseNumberExtensionMatch": str,
        "birthdateMatch": str,
        "emailMatch": str,
        "genderMatch": str
    }
}

Example:

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

async def main():
    glide = GlideClient()
    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)
    # Output: {"status": "success", "data": {"idDocumentMatch": "true", "nameMatch": "true", ...}}

asyncio.run(main())