Know Your Customer Fill-in
Know Your Customer (KYC) Fill-in allows you to retrieve information related to a customer's identity stored in their teleoperator's records using their phone number. This API helps you verify the accuracy of customer-provided personal data, ensuring compliance and streamlining account creation processes.
Performing a KYC Fill-in
KYC Fill-in requires you to know the customer's phone number, which will then be used to identify the user in their teleoperator's customer database. The KYC Fill-in capability is then able to retrieve other customer fields, such as names, addresses, nationalities and so on based on what information the teleoperator has on file and what information the application has been granted access to.
An example, here is how you can perform a KYC Fill-in request:
import network_as_code as nac
# Initialize the client object with your application key
client = nac.NetworkAsCodeClient(
token="<your-application-key-here>"
)
# To use the request_customer_info method you must provide the customer's phone number.
result = client.kyc.request_customer_info(
phone_number="+99999991000"
)
# If successful, you can access the results like so:
print(result)The request is populated with the following parameters:
| Parameter | Description | Mandatory or Optional |
|---|---|---|
phone_number | A public identifier addressing a telephone subscription, formatted in international format according to E.164 standard (prefixed with '+'). Example: "+123456789". | Mandatory |
The result will be an object containing the following fields:
| Field | Description |
|---|---|
phone_number | The phone number associated with the customer's identity. |
id_document | A unique identifier for the customer's official document, if provided. |
id_document_type | The type of ID document (e.g., passport, national_id_card). |
id_document_expiry_date | The expiration date of the ID document in ISO 8601 format. |
name | Full legal name of the customer as stored on their official documents. |
given_name | First or given name(s) of the customer, without middle names. |
family_name | Last or family name(s) of the customer, without middle names. |
name_kana_hankaku | Name written in Hankaku-Kana format (Japanese syllabary used for Japanese sounds). |
name_kana_zenkaku | Name written in Zenkaku-Kana format (Japanese syllabary using full-width characters). |
middle_names | Middle name(s) of the customer. |
family_name_at_birth | Family or surname the customer was given at birth, if applicable. |
address | Complete address where the customer resides as recorded by their Operator. |
street_name | Name of the street where the customer's residence is located. |
street_number | The numerical part of the address (e.g., house number or building name). |
postal_code | Postal code associated with the customer's location as per their Operator's records. |
region | Region, state, or prefecture where the customer resides, according to the Operator's system. |
locality | City or locality within which the customer is based. |
country | Country of residence for the customer as recorded by their Operator (ISO 3166-1 alpha-2 format). |
house_number_extension | Additional specific identifier for a house, such as apartment numbers, if applicable. |
birthdate | Date of birth in ISO 8601 calendar date format (YYYY-MM-DD). |
email | Email address provided by the customer and associated with their account on record. |
gender | The gender declared by the customer as per official documents or recorded by their Operator. |
city_of_birth | City where the customer was born according to their records. |
country_of_birth | Country of birth in ISO 3166-1 alpha-2 format for the country where the customer's motherland is located. |
nationality | Nationality or citizenship status, typically associated with the ID document provided by the customer. |
The response format will contain all the fields that were successfully retrieved from the teleoperator's records for the given phone number.
Note: Not all fields will be available for every customer or operator, so the response will only contain fields that have been successfully matched and retrieved from the records.
This functionality ensures that you can quickly verify and retrieve essential personal information about customers using their phone numbers, helping to streamline KYC processes and improve account verification efficiency.
Last updated December 19, 2025