Feature Profiling-Singapore

API Method

Base URL

API

URLRequest MethodsContent-TypeOutput FormatCharacter Set
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

Authentication

ParameterTypeDescriptionRequired/OptionalNotes
partner_codeStringPartner CodeRequiredassigned by TD
partner_keyStringPartner KeyRequiredassigned by TD

Request

ParameterTypeDescriptionRequired/OptionalNotes
id_numberStringID numberRequiredID number,i.e. CURP for Mexico
id_typeStringID typeRequiredID type enumeration value:
National ID card: national_id
countryStringCountryRequiredTwo-digit country code, compliant with ISO 3166 standard.
Supported countries: Mexico (MX), India (IN), Thailand (TH), Colombia (CO), Philippines(PH), Vietnam (VN), Nigeria (NG), Pakistan (PK)
nameStringNameRequired
phone_numberStringPhone numberRequiredIndia/Mexico/Thailand: without country code, 10 digits in total;
Philippines: without country code, a total of 11 digits
Nigeria, Vietnam, Thailand, Pakistan: without country code, starting with 0
app_nameStringApp nameStrongly recommendedThis field is strongly recommended if the packages exclude behavior_analysis_of_repayment and multiplatform_multi_V1_1 are selected.
package_nameStringPackage nameRequiredEnumeration value:
Mexico, India, Thailand, Colombia,Philippines:
credit_rating_estimation: Credit Rating Prediction
multiplatform_multi:Multiplatform V1.0
behavior_analysis_of_repayment :behavior analysis of repayment
multiplatform_multi_V1_1:Multiplatform V1.1

Vietnam, Nigeria, Pakistan:
behavior_analysis_of_repayment :behavior analysis of repayment
multiplatform_multi_V1_1:Multiplatform V1.1

Only one can be filled .

Response Parameter

ParameterTypeRequired/OptionalDescriptionRequired/Optional
codeIntegerRequiredAPI status code
messageStringRequiredStatus informationIn the API exception state, the specific exception reason will be output.
sequence_idStringRequiredResponse unique codeUnique identifier used to track each request record
dataArrayRequired
indicator_nameStringRequiredIndicator name
indicator_valueString/intRequiredIndicator valueThe meaning of the special value of the indicator:
-1111: Unable to calculate
-999: No record in the library
Remark: the type of parameter will be different according to different indicators
indicator_statusIntRequired Indicator statusEnumeration value:
200: Success
201: No record in the library (no record of mobile phone number and ID number)
202: Indicator cannot be calculated
500: System error

API Interface Response Code

CodeMessageDescription
200Success
300Service not purchased or not effectiveService not purchased or not effective
301Service not purchasedService not purchased
302Service has been suspendService has been suspend
303Not enough balanceNot enought blance
304Service expiredService expired
9500Internal errorInternal error
9060{parameter} empty{parameter} empty
9061{parameter} error{parameter} error
9055The country partner located has no serviceThere is no service in your country/region
9081The format of the phone number does not match with the countryThe format of the phone number does not match with the country

Response Example

{
    "code":200,
    "sequence_id":"53b63090c0374cad82********f8991e",
    "data":[
        {
            "indicator_name":"indicator_name_1",
            "indicator_status":200,
            "indicator_value":1
        },
        {
            "indicator_name":"indicator_name_2",
            "indicator_status":200,
            "indicator_value":1
        }
    ]
}

Failed Example

{
    "code": 9061,
    "sequence_id": "80b57561b6fb********61ccba263b60",
    "message": "country error"
}