Loan Applications Check API
Provides the information based on the telco scoring inquiries of a user. Loan Applications Check is currently available only for SMART and Globe numbers.
Authentication
Prerequisites
In order to obtain an API Token you first need to have client_id and client secret from the previous step.
Token Request Flow
To authenticate and obtain an OAuth token, follow the standard OAuth token request flow.
POST API URL
Copy
Grant Type
Use this grant type when the client is a server and does not require user authentication.
Copy
Requesting the Access Token
To request the Access Token, submit a POST request to the API URL, including the following body parameters in JSON format:
Copy
Handling the Token Response
Upon successful validation, the authorization server will respond with an access token:
Token Lifespan
Access tokens have a limited lifespan of 86400 seconds. Once the token expires, you can obtain a new one.
Endpoint
The API endpoint for accessing the telco score is:
Request Parameters
The request should include the following parameters:
mobileNumber
Yes
Should contain the SMART number of the client for whom you want to generate the Loan Applications Check.Format 639XXXXXXXXX
productIds
Yes
parameter is a semicolon-separated list of product codes that you want to use for Loan Applications Check. For this API request, the productIds should be "911;".
requestId
Yes
Identifier for the API request. It should be a unique value for each API call.
Response Parameters
The API response will be in JSON format and will include the following fields:
requestId
string
Yes
Unique identifier
transactionId
string
Yes
Unique system identifier
code
string
Yes
Operation code
result
string
Yes
Operation result
scores
string
Yes
Semicolon separated string scoring product identifiers (product id 911)
911
Object
yes
cvTotals
Object
yes
requestsTotalAll
Integer
Yes
# all previous requests, including such performed by the Client requesting Loan Applications Check
uniqueEntitiesTotalAll
Integer
Yes
# of unique Lending institutions who performed the requests, including the Client requesting Loan Applications Check
requestsSameTotalAll
Integer
Yes
# of all previous requests performed by the Client requesting Loan Applications Check
requestsOtherTotalAll
Integer
Yes
# of all previous requests, excluding such performed by the Client requesting Loan Applications Check
requestsTotal1
Integer
Yes
# of all previous requests, including such performed by the Client requesting Loan Applications Check - 1 Day before the Main request date
requestsTotal7
Integer
Yes
Same as above, but "Last 7 days" (includes "_1")
requestsTotal14
Integer
Yes
Same as above, but "Last 14 days" (includes "_1" and "_7")
requestsTotal21
Integer
Yes
Same logic as above
requestsTotal28
Integer
Yes
Same logic as above
requestsTotal35
Integer
Yes
Same logic as above
requestsTotal45
Integer
Yes
Same logic as above
requestsTotal60
Integer
Yes
Same logic as above
requestsTotal90
Integer
Yes
Same logic as above
requestsTotal180
Integer
Yes
Same logic as above
requestsTotal360
Integer
Yes
Same logic as above
uniqueEntities1
Integer
Yes
# of unique Lending institutions who performed the requests, including the Client requesting Loan Applications Check - 1 Day before the Main request date
uniqueEntities7
Integer
Yes
Same as above, but "Last 7 days" (includes "_1")
uniqueEntities14
Integer
Yes
Same as above, but "Last 14 days" (includes "_1" and "_7")
uniqueEntities21
Integer
Yes
Same logic as above
uniqueEntities28
Integer
Yes
Same logic as above
uniqueEntities35
Integer
Yes
Same logic as above
uniqueEntities45
Integer
Yes
Same logic as above
uniqueEntities60
string
Yes
Same logic as above
uniqueEntities90
Integer
Yes
Same logic as above
uniqueEntities180
Integer
Yes
Same logic as above
uniqueEntities360
Integer
Yes
Same logic as above
requestsSame1
Integer
Yes
# of all previous requests performed by the Client requesting Loan Applications Check - 1 Day before the Main request date
requestsSame7
Integer
Yes
Same as above, but "Last 7 days" (includes "_1")
requestsSame14
Integer
Yes
Same as above, but "Last 14 days" (includes "_1" and "_7")
requestsSame21
Integer
Yes
Same logic as above
requestsSame28
Integer
Yes
Same logic as above
requestsSame35
Integer
Yes
Same logic as above
requestsSame45
Integer
Yes
Same logic as above
requestsSame60
Integer
Yes
Same logic as above
requestsSame90
Integer
Yes
Same logic as above
requestsSame180
Integer
Yes
Same logic as above
requestsSame360
Integer
Yes
Same logic as above
requestsOthers1
Integer
Yes
# of all previous requests, excluding such performed by the Client requesting Loan Applications Check - 1 Day before the Main request date
requestsOthers7
Integer
Yes
Same as above, but "Last 7 days" (includes "_1")
requestsOthers14
Integer
Yes
Same as above, but "Last 14 days" (includes "_1" and "_7")
requestsOthers21
Integer
Yes
Same logic as above
requestsOthers28
Integer
Yes
Same logic as above
requestsOthers35
Integer
Yes
Same logic as above
requestsOthers45
Integer
Yes
Same logic as above
requestsOthers60
Integer
Yes
Same logic as above
requestsOthers90
Integer
Yes
Same logic as above
requestsOthers180
Integer
Yes
Same logic as above
requestsOthers360
Integer
Yes
Same logic as above
requestsBank1
Integer
Yes
# of all previous requests performed by Banks, excluding such performed by the Client requesting Loan Applications Check - 1 Day before the Main request date
requestsBank7
Integer
Yes
Same as above, but "Last 7 days" (includes "_1")
requestsBank14
Integer
Yes
Same as above, but "Last 14 days" (includes "_1" and "_7")
requestsBank21
Integer
Yes
Same logic as above
requestsBank28
Integer
Yes
Same logic as above
requestsBank35
Integer
Yes
Same logic as above
requestsBank45
Integer
Yes
Same logic as above
requestsBank60
Integer
Yes
Same logic as above
requestsBank90
Integer
Yes
Same logic as above
requestsBank180
Integer
Yes
Same logic as above
requestsBank360
Integer
Yes
Same logic as above
requestsNonBank1
Integer
Yes
# of all previous requests performed by non banks, excluding such performed by the Client requesting Loan Applications Check - 1 Day before the Main request date
requestsNonBank17
Integer
Yes
Same as above, but "Last 7 days" (includes "_1")
requestsNonBank14
Integer
Yes
Same logic as above
requestsNonBank21
Integer
Yes
Same logic as above
requestsNonBank28
Integer
Yes
Same logic as above
requestsNonBank35
Integer
Yes
Same logic as above
requestsNonBank45
Integer
Yes
Same logic as above
requestsNonBank60
Integer
Yes
Same logic as above
requestsNonBank90
Integer
Yes
Same logic as above
requestsNonBank180
Integer
Yes
Same logic as above
requestsNonBank360
Integer
Yes
Same logic as above
scorePtd
Integer
Yes
The raw score generated by the Payment Transaction Data model, representing predicted customer risk (higher score = better).
bandPtd
Integer
Yes
Score percentile band based on the development sample, segmented into 10 risk groups (1 = highest risk, 10 = lowest risk).
Example
POST Loan Application Check without telco score for SMART
Example Response
POST Loan Application Check with telco score for SMART
Example Response
Last updated