Guide to Using ID Credit EVAL Score CateA API

Overview: The ID Credit EVAL Score CateA API provides a way to retrieve credit evaluation scores based on specific customer data inputs. This guide will walk you through the setup, necessary parameters, and process to integrate the API into your system.

1. Getting Started: Before you begin, ensure you have access to your accessKey and secretKey from the Websaas Platform. This information is essential for generating the necessary authentication tokens to make API requests.

2. Authentication Token Generation: You must first generate an Access Token to authenticate your API requests. Use the following endpoint:

URL: https://api.advance.ai/openapi/auth/ticket/v1/generate-token
Method: POST
Headers: Content-Type: application/json
Request Parameters:
- accessKey: The key provided by your account.
- signature: The SHA256 encrypted combination of accessKey, secretKey, and timestamp.
- timestamp: A 13-digit timestamp.
- periodSecond (optional): Token validity period, defaults to 3600 seconds.

Here’s a sample request:

curl -X POST \
-H "Content-Type: application/json" \
-d '{"accessKey":"yourAccessKey","signature":"encryptedSignature","timestamp":yourTimestamp,"periodSecond":120}' \
"https://api.advance.ai/openapi/auth/ticket/v1/generate-token"

3. Making a Credit Evaluation Request: Once your token is ready, you can make a credit evaluation request using the ID Credit EVAL Score CateA API. Here's how:

URL: https://api.advance.ai/openapi/score/v1/credit-eval-score-catea
Method: POST
Headers:
- X-ACCESS-TOKEN: Your access token
- Content-Type: application/json

Request Body Parameters:

name (string): Customer's full name, should be at least 3 characters.
idNumber (string): Customer's ID number (must be a 16-digit number, no leading zeros).
phoneNumber (string): Customer’s phone number (must start with "+628").

Sample Request:

curl -X POST \
-H "X-ACCESS-TOKEN: yourAccessToken" \
-H "Content-Type: application/json" \
-d '{
    "name": "John Doe",
    "idNumber": "1234567890123456",
    "phoneNumber": "+6281234567890"
}' \
"https://api.advance.ai/openapi/score/v1/credit-eval-score-catea"

4. Handling Responses: The API returns JSON-formatted responses. Key fields to note:

Code: The status of the API request (SUCCESS for successful calls).
Data: Contains customer credit evaluation scores and associated features.
Transaction ID: A unique ID for each transaction that should be logged.

Success Response Example:

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
      "score": 750,
      "features": {
          "GD_X_1": 100.0,
          "GD_X_2": 1500.5,
          // additional feature values...
      }
  },
  "transactionId": "uniqueTransactionId",
  "pricingStrategy": "PAY"
}

Further Assistance

If you continue to experience issues despite following the guidelines provided, please contact our support team for further assistance:

Guide to Using ID Credit EVAL Score CateA API

Further Assistance

Articles in this section

Comments