Phone KYC - Phone to Prefill V2

Introduction:

This API helps clients in understanding their users demographic profile. The API consume Phone Number and Name of a customer to give registered address of the user. The result contains upto 5 alternate addresses of a user. The Address information is detailed and can be used to profile users on the basis the Pincode or offer the users a convenient option to choose their delivery or communication address.

Key Features

Comprehensive Data Retrieval: The API gathers extensive information, covering contact details, address history, identification documents, and demographic data, based on the provided Phone Number and Name inputs.

Applications

Versatile Pre-Filling Integration: This API seamlessly integrates into various pre-filling use cases, offering efficient retrieval of user details to streamline processes across different domains.

Conclusion

In conclusion, the User Prefill API presents a versatile solution for clients seeking to access their users' prefill details using Phone Number and Name inputs. Its seamless integration into pre-filling use cases enhances efficiency across diverse processes requiring comprehensive user information.

Sample cURL:

curl --location 'https://api.signzy.app/api/v3/phonekyc/phone-prefill-v2' \
--header 'Content-Type: application/json' \
--header 'Authorization: ********' \
--data '{
    "mobileNumber": "8122244473",
     "fullName": "SATHISH KUMAR",
     "consent": {
        "consentFlag": "true",
        "consentTimestamp":11000,
        "consentIpAddress":"684D:1111:222:3333:",
        "consentMessageId":"CM_1"
    }
    
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
mobileNumber	String	Phone Number of the Individual	Mandatory
fullName	String	Full Name of the Individual	Optional
consent	Object	Consent provided by Individual	Mandatory
consent[consentFlag]	Boolean	A boolean flag representing if consent is present or not.	Mandatory
consent[consentTimestamp]	Number	Timestamp of consent provided by user in seconds.	Mandatory
consent[consentIpAddress]	String	Ip address of the user's device giving the consent.	Mandatory
consent[consentMessageId]	String	It is a mapping of consent messageId to consent message	Mandatory

ID	Message
CM_1	I hereby consent that I am sharing my consent to signzy to collect my bureau report

Sample Response:

{
    "response": {
        "alternatePhone": [
            {
                "serialNo": "1",
                "phoneNumber": "8122244473"
            },
            {
                "serialNo": "2",
                "phoneNumber": "9787772762"
            },
            {
                "serialNo": "3",
                "phoneNumber": "9842372492"
            },
            {
                "serialNo": "4",
                "phoneNumber": "8122244473"
            },
            {
                "serialNo": "5",
                "phoneNumber": "8122244473"
            },
            {
                "serialNo": "6",
                "phoneNumber": "9047052224"
            }
        ],
        "email": [
            {
                "serialNo": "1",
                "email": "[email protected]"
            }
        ],
        "address": [
            {
                "Seq": "1",
                "ReportedDate": "2024-05-31",
                "Address": "223 N A THEVAR STREET  OLYMBUS COIMBATORE SOUTH COIMBATORE SOUTH DISTRICT",
                "State": "TN",
                "Postal": "641045",
                "Type": "Owns"
            },
            {
                "Seq": "2",
                "ReportedDate": "2024-04-25",
                "Address": "223 NACHIANNAN ANGANNAN STREET  RAMANATHAPURAM COIMBATORE",
                "State": "TN",
                "Postal": "641045",
                "Type": "Rents,Primary"
            },
            {
                "Seq": "3",
                "ReportedDate": "2023-09-01",
                "Address": "NO-223 NACHIANNAN ANGANNAN STREET  RAMANATHAPURAM TAMILNADU 641045",
                "State": "TN",
                "Postal": "641045",
                "Type": "Primary"
            },
            {
                "Seq": "4",
                "ReportedDate": "2016-09-16",
                "Address": "NO-223 NACHIANNAN ANGANNAN STREET  RAMANA THAPURAM RAMANATHAPURAM COIMBATORE",
                "State": "TN",
                "Postal": "641045"
            },
            {
                "Seq": "5",
                "ReportedDate": "2016-09-16",
                "Address": "KIKANI EXPORT PVT LTD  104 WEST PERIASAMA Y ROAD  R S PRUAM COIMBATORE",
                "State": "TN",
                "Postal": "641045"
            }
        ],
        "voterId": [
            {
                "seq": "1",
                "ReportedDate": "2024-05-31",
                "IdNumber": "ROG0032698"
            }
        ],
        "PAN": [
            {
                "seq": "1",
                "ReportedDate": "2024-05-31",
                "IdNumber": "BUXPS2681D"
            }
        ],
        "name": {
            "fullName": "SATHISH KUMAR ",
            "firstName": "SATHISH ",
            "lastName": "KUMAR "
        },
        "income": "420000000",
        "gender": "Male",
        "age": "38",
        "dob": "1986-06-03"
    }
}

Output Parameters:

Key	Type	Description
response	Object	The main object contains response data.
response.alternatePhone	Array of Objects	List of Phone Numbers associated with the user.
response.alternatePhone.serialNo	Number	Unique identifier for the alternate phone number (multiple entries possible).
response.alternatePhone.phoneNumber	String	The alternate phone number (multiple entries possible).
response.email	Array of Objects	List of Emails associated with the user.
response.email.serialNo	Number	Unique identifier for the email address (multiple entries possible).
response.email.email	String	The email address (multiple entries possible).
response.address	Array of Objects	List of Addresses associated with the user.
response.address.Seq	String	Unique identifier for the address record (might not be sequential).
response.address.ReportedDate	String	Date the address was reported (YYYY-MM-DD format).
response.address.Address	String	Full address information.
response.address.State	String	State code of the address.
response.address.Postal	String	Postal code of the address.
response.address.Type	String	Type of address (e.g., "Office", "Primary", "Permanent").
response.drivingLicense	Array of Objects	Represents the List of Driving Licenses
response.drivingLicense.serialNo	Number	Unique identifier for the driving license (multiple entries possible).
response.drivingLicense.drivingLicense	String	The driving license number (multiple entries possible).
response.voterId	Array of Objects	Represents the List of Voter Ids
response.voterId.serialNo	Number	Unique identifier for the Voter Id (multiple entries possible).
response.voterId.voterId	String	VoterId number (multiple entries possible)
response.passport	Array of Objects	Represents the List of Passports
response.passport.serialNo	Number	Unique identifier for the passport (multiple entries possible).
response.passport.passport	String	Passport Number (multiple entries possible)
response.pan	String	PAN card number of the individual.
response.name	Object
response.name.fullName	String	Full name of the individual.
response.name.firstName	String	First name of the individual.
response.name.lastName	String	Last name of the individual.
response.income	String	Reported income of the individual.
response.gender	String	Gender of the individual (e.g., "Male", "Female").
response.age	String	Age of the individual.
response.dob	String	Date of birth of the individual (YYYY-MM-DD format).

State Code Mappin

Value	Description	Pincode Range (First 3 Numbers)
AN	Andaman & Nicobar Islands	744
AP	Andhra Pradesh	500 - 535
AR	Arunachal Pradesh	790 - 792
AS	Assam	781 - 788
BR	Bihar	800 - 855
CG, CT	Chhattisgarh	490 - 497
CH	Chandigarh	160
DD	Daman & Diu	362, 396
DL	Delhi	110
DN	Dadra & Nagar Haveli	396
GA	Goa	403
GJ	Gujarat	360 - 396
HP	Himachal Pradesh	171 - 177
HR	Haryana	121 - 136
JH	Jharkhand	813 - 835
JK	Jammu & Kashmir	180 - 194
KA	Karnataka	560 - 591
KL	Kerala	670 - 695
LD	Lakshadweep	682
MH	Maharashtra	400 - 445
ML	Meghalaya	793 - 794
MN	Manipur	795
MP	Madhya Pradesh	450 - 488
MZ	Mizoram	796
NL	Nagaland	797 - 798
OR	Odisha	751 - 770
PB	Punjab	140 - 160
PY	Pondicherry/Puducherry	533, 605, 607, 609
RJ	Rajasthan	301 - 345
SK	Sikkim	737
TG, TS	Telangana	500 - 509
TN	Tamil Nadu	600 - 643
TR	Tripura	799
UL	Uttarakhand	244 - 263
UP	Uttar Pradesh	201 - 285
WB	West Bengal	700 - 743

Status Codes:

{
    "error": {
        "statusCode": 400,
        "status": "Bad Request",
        "message": "\"requestBody.mobileNumber\" is required",
        "id": "713fe5b4-28b2-402d-b356-6660fd131bd7"
    }
}
1. "\"requestBody.mobileNumber\" is required"