# Credit Score V1-A Credit Score

# 1. Description

This API performs a risk query on a single image and returns the risk query result.

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

POST (request must use form-data format).

Optional/Required	Parameter	Type	Description
Required	sign	String	The signature of the customer calling this API. For the signature generation method, refer to the "Authentication" document.
Required	sign_version	String	Signature algorithm version. Pass: hmac_sha1.
Required	image	File	The image to be detected (must not exceed 2 MB).

Parameter	Name	Type	Description
request_id	Request ID	String	A unique string used to distinguish each request. This field is always returned unless the error 404 (API_NOT_FOUND) occurs.
time_used	Request duration	Int	The time taken by the entire request, in milliseconds.
error_message	Error message	String	Returned when the HTTP status code is not 200.
visual_risk	Credit Score	String	Value range [300, 850]. A higher score indicates better credit.

(This API does not depend on faces, so there is no NO_FACE_FOUND error.)

HTTP status code	Error message	Description
200		Normal value. The server successfully returned the data requested by the user.
400	INVALID_IMAGE	The image exceeds 2 MB.
400	IMAGE_ERROR_UNSUPPORTED_FORMAT	The uploaded image cannot be parsed.
400	MISSING_ARGUMENTS:	A required parameter is missing.
400	BAD_ARGUMENTS:	An error occurred while parsing a parameter (for example, a number is required but a non-numeric string was entered, or the value is too long, etc.).
400	REQUEST_ERROR	Request exception.
401	AUTHENTICATION_ERROR	Invalid signature.
403	CONCURRENCY_LIMIT_EXCEEDED	The concurrency limit is exceeded.
403	AUTHORIZATION_ERROR:	The api_key is disabled, the call limit is exceeded, there is no permission to call this API, or no permission to call this API in the current manner. Valid values for : - API_KEY_BE_DISCONTINUED: the api_key is disabled - LIMIT_REACHED: this api_key has reached the call limit for the current API (only for test keys) - DENIED: no permission to call the current API - EXPIRED_SIGN: the signature has expired - INVALID_SIGN: invalid signature.
404	API_NOT_FOUND	The API does not exist.
500	INTERNAL_ERROR	Internal server error. If this error occurs, send the request again. If this persists, contact the technical support team promptly.

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

ERROR (invalid signature, concurrency limit exceeded)

{
 "error": "AUTHORIZATION_ERROR: INVALID_SIGN"
}

ERROR_MESSAGE (image size exceeded, no face found, etc.)

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