Phone KYC - Bureau Score

Introduction:

The Bureau Score API simplifies the process for clients to retrieve Credit bureau scores based on user information such as PhoneNumber, FirstName, LastName and the requested credit bureau(s). When a client submits a request with a user's personal details and specifies the desired bureau (e.g., "Experian"), the API queries the relevant credit bureau and returns the associated credit score. This functionality is essential where quick access to a user's creditworthiness is required to assess risk and make informed lending decisions.

Sample cURL:

curl --location 'https://api-preproduction.signzy.app/api/v3/phonekyc/bureau-score' \
--header 'Authorization: <auth token>' \
--header 'Content-Type: application/json' \
--data '{
    "phoneNumber": "8462892317",
    "firstName": "JOHN",
    "lastName": "DOE",
    "productName": ["experian"]
}'

Request Headers:

Key	Value
Authorization	shared by Signzy
Content-type	application/json

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
phoneNumber	String	Phone Number of the Individual	Mandatory
firstName	String	First Name of the Individual	Mandatory
lastName	String	Last Name of the Individual	Mandatory
productName	Array	Credit Bureau like "experian"	Mandatory

Sample Response:

{
    "result": [
        {
            "bureau": "Experian",
            "phone": "8462892317",
            "name": "JOHN DOE",
            "score": "774"
        }
    ]
}

Output Parameters:

Key	Type	Description
result	Array	The main Array contains response data.
productName.bureau	String	Name of the Bureau.
productName.phone	String	Phone Number associated with the user.
productName.name	String	Name of the user.
productName.score	String	Credit Score of the Bureau

Status Codes:

{
    "error": {
        "reason": "ERROR",
        "status": 500,
        "message": "Internal Server Error",
        "type": "Internal Server Error",
        "statusCode": 500,
        "name": "error"
    }
}