# Credit Score V2-B-PHL

# 1. Description

Returns risk query results based on three input parameters.

# 2. API-URL

https://api-sgp.yljz.com/finauth/v3/visual/riskscore_plus_phl

# 3. Method

POST (requires form-data request format)

# 4. Request Parameters

Required/Optional	Parameter	Type	Description
Required	sign	String	Client signature for this API call. Refer to the "Authentication" document for signature generation
Required	sign_version	String	Signature algorithm version, pass: hmac_sha1
Required	idcard_number	String	ID number (md5/sha256/sm3). Note: letters must be uppercase
Required	idcard_type	String	ID type, pass the corresponding number (see table below)
Required	mobile_number	String	Phone number (md5/sha256/sm3). Note: do not include country code
Required	image	File	Image to be processed (max 2MB)
Optional	hash_type	String	Hash method for ID and phone number: md5 (default), sha256, sm3

# idcard_type Values

Value	ID Type
1	National ID / PhilID
2	CRN / UMID
3	SSS Number
4	GSIS Number
5	PHIC / PhilHealth Number
6	Pag-IBIG MID Number
7	TIN
8	Philippine Passport Number
9	LTO Driver's License No.
10	Voter's ID Number
11	PRC ID Number
12	Postal ID Number

# 5. Response Parameters

Parameter	Description	Type	Details
request_id	Request ID	String	Unique string to identify each request. Always returned except for 404 (API_NOT_FOUND) errors
time_used	Time Used	Int	Total request duration in milliseconds
error_message	Error Message	String	Returned when HTTP status code is not 200
visual_risk1_phl	JinJi Score 1	String	Range [300, 850]. Higher score indicates better credit
visual_risk2_phl	JinJi Score 2	String	Range [300, 850]. Higher score indicates better credit

# 6. API-Specific Error Messages

HTTP Status	Error Message	Description
200	Normal	Server successfully returns requested data
400	INVALID_IMAGE	Image exceeds 2MB
400	IMAGE_ERROR_UNSUPPORTED_FORMAT	Uploaded image cannot be parsed
400	MISSING_ARGUMENTS: <key>	Missing a required parameter
400	BAD_ARGUMENTS:<key>	Parameter parsing error (e.g., non-numeric string where number expected, or value too long)
400	REQUEST_ERROR	Request exception
401	AUTHENTICATION_ERROR	Invalid signature
403	CONCURRENCY_LIMIT_EXCEEDED	Concurrency limit exceeded
403	AUTHORIZATION_ERROR:<reason>	API key disabled, call limit exceeded, or no permission (see reasons below)
404	API_NOT_FOUND	API does not exist
500	INTERNAL_ERROR	Internal server error. Retry the request; contact technical support if persistent

# AUTHORIZATION_ERROR Reasons

Reason	Description
API_KEY_BE_DISCONTINUED	API key has been disabled
LIMIT_REACHED	Call limit reached for this API key (test key only)
DENIED	No permission to call this API
EXPIRED_SIGN	Signature has expired
INVALID_SIGN	Invalid signature

# 7. Example Responses

# Success

{
  "request_id": "1716883855,a080638e-2483-424f-8d35-3566bd9c421b",
  "time_used": 1672,
  "visual_risk": "724"
}

# Failure — Invalid Signature

{
  "error": "AUTHORIZATION_ERROR: INVALID_SIGN"
}

# Failure — Missing Image

{
  "request_id": "1716884001,57e093f8-f923-44f3-8ee0-4df5e0e79b31",
  "time_used": 0,
  "error_message": "MISSING_ARGUMENTS:image"
}