API Reference
中文

Credit Scoring - Indonesia

This solution provides a concise summary of an applicant's creditworthiness, enabling lenders to make well-informed decisions efficiently.

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,KTP
id_typeStringID typeRequiredID type enumeration value:
National ID card: national_id
countryStringCountryRequiredTwo-digit country code, compliant with ISO 3166 standard.
Currently supported: Indonesia (ID)
nameStringNameRequired
phone_numberStringPhone numberRequiredIndonesia only supports 10-13 pure numbers and + sign. Plain text only supports the following as the beginning: + 628, 628, 8, 08
app_nameStringApp nameStrongly recommended
package_nameStringPackage nameRequiredEnumeration value, Only one can be selected:
Indonesia Site:
finscore_5_1_1
fisncore_4_3_1
td_device_credit_score
td_device_credit_score_2: Device Credit Score V2
device_idStringDevice IDStrongly recommendedIt is strongly recommended to fill in the fingerprint if accessing the device.
apply_timeStringapplication timeConditionally requiredRequired when selecting finscore_5_1_1.
Complies with ISO 8601 standard, format YYYY-MM-DDTHH:mm:ss.sssZ, for example, 2021-10-12T14:20:50.521+07:00
gaidStringGoogle Advertising IDConditionally requiredRequired when selecting td_device_credit_score and td_device_credit_score_2

Response Parameter

ParameterTypeDescriptionRequired/Optional
codeIntegerAPI status code
messageStringStatus informationIn the API exception state, the specific exception reason will be output.
sequence_idStringResponse unique codeUnique identifier used to track each request record
dataObject
reference IntReference Only exist in td_device_credit_score_2
Enumeration values: 1; 2
package_nameStringPackage name
scoreStringPackage scoreThe meaning of the special value of the score :

- 1111: Unable to calculate
detailsObjectModel detailsOnly existing for td_device_credit_score
indicator_nameStringIndicator nameOnly existing for td_device_credit_score, please contact us for the data dictionary.
indicator_valueStringIndicator Only existing for td_device_credit_score

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 enough balance
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
9050No recordNo record

Response Example-Success

{
    "code":200,
    "data":[
        {
            "package_name": "finscore_4_3_1",
            "score":"554.0"
        }
    ],
    "sequence_id":"3967684575d64e3a9da3a3af1d94****"
}

Response Example for td_device_credit_score

{
    "code":200,
    "data":[
        {
            "score":"0.1121",
            "package_name":"td_device_credit_score",
            "details":[
                {
                    "indicator_name":"top1_feature",
                    "indicator_value":"L2"
                }
            ]
        }
    ],
    "sequence_id":"1706233470******Y082C3398005C001"
}

No record Example for td_device_credit_score

{
    "code":9050,
    "message":"No record",
    "sequence_id":"1706234638486000Y083E238****C001"
}

Response Example for td_device_credit_score_2(reference 1)

{
    "code":200,
    "data":[
        {
            "score":"0.1121",
            "package_name":"td_device_credit_score_2",
            "reference":1,
            "details":[
                {
                    "indicator_name":"top1_feature",
                    "indicator_value":"L2"
                }
            ]
        }
    ],
    "sequence_id":"1706233470******Y082C3398005C001"
}

Response Example fortd_device_credit_score_2(reference 2)

{
    "code": 200,
    "data": [
        {
            "score": "0.1121",
            "package_name": "td_device_credit_score_2",
            "reference": 2
        }
    ],
    "sequence_id": "1706233470******Y082C3398005C001"
}

Failed Example

{
    "code": 9061,
    "message": "country error",
    "sequence_id":"1706212338486000Y083E238****C001"
}