/verify/indian_anti_fraud

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

Help customers identify high-risk users who have co-loan behavior (co-loan behavior refers to loan from multiple parties at the same time for a period of time) This API is required to input the ID number that can represent the identity of the user(aadhaar、pan、voterid), and return the number of registered organizations and query on organizations of the user that can be found in our database.

Request Method

POST

Request URL

https://cloudapi.accuauth.in/verify/indian_anti_fraud

Debugging Tool

Debugging Tool

2.Request Params

2.1 Request Header

Parameter Type Required Description
X-DF-API-ID string Yes For API credentials,Please visit API Request
X-DF-API-SECRET string Yes For API credentials,Please visit API Request

2.2 Request Body

Required Fields Type Description
required card_type string The card type:pan, aadhaar, voterid or bank_account
required card_no string The card number
required date_before string The query base date, default is current time. The API only return result of before date_before.

3.Response Params

Fields Type Description
request_id string Unique id of each request
status string Response status, OK for success request, Error Codes for failed request
result object The query result

3.1 Elements in result

Fields Type Description
card_no string The card number,same as request param card_no
card_type string The card type,same as request param card_type
stats object Number of registries and querying agencies in different time periods, including: all_time, 90_days(within 90 days), 30_days(within 30 days), 15_days(within 15 days), 7_days((within 7 days)

3.2 Elements in stats

Fields Type Description
all_time object all result of before date_before
90_days object result within 90 days before date_before
30_days object result within 30 days before date_before
15_days object result within 15 days before date_before
7_days object result within 7 days before date_before

3.3 Elements in all_time/N_days

Fields Type Description
query_count object Number of query agencies in current date range
registry_types object The types of regitry agency,default is paydayloan,return format: {"paydayloan": N}
registry_count object Number of registry agencies in current date range

Response Syntax
{
    "status": "OK",
    "request_id": "TID0e123cb8b1a94b57897e9d7bbecfaca6",
    "result": {
        "card_type": "pan",
        "card_no": "BOUPC1317R",
        "date_before": "2020-03-26",
        "stats": {
            "all_time": {
                "query_count": 51,
                "registry_types": {
                    "paydayloan": 5
                },
                "registry_count": 5
            },
            "90_days": {
                "query_count": 39,
                "registry_types": {
                    "paydayloan": 5
                },
                "registry_count": 5
            },
            "30_days": {
                "query_count": 25,
                "registry_types": {
                    "paydayloan": 2
                },
                "registry_count": 2
            },
            "15_days": {
                "query_count": 10,
                "registry_types": {
                    "paydayloan": 2
                },
                "registry_count": 2
            },
            "7_days": {
                "query_count": 3,
                "registry_types": {
                    "paydayloan": 1
                },
                "registry_count": 1
            }
        }
    }
}

4.Error Codes

Common error codes of this API:

Http Status Code Status Field Description
400 INVALID_ARGUMENT Request parameter is invalid
400 QUERY_FAILED Query failed
400 ABNORMAL_BEHAVIOURS_DETECTED Request with same parameters repeated more than amount of times
401 UNAUTHORIZED Unauthorized or access is denied
401 KEY_EXPIRED Your API ID has expired
403 NO_PERMISSION You are not authorized to use this API
403 OUT_OF_QUOTA API calls quota exceeded
403 RATE_LIMIT_EXCEEDED API request frequency exceeds the limit
404 NOT_FOUND Requested API cannot be found
500 INTERNAL_ERROR Internal server error

Comment: Please see the reason field for details when the above 40X / 51X error occurred

Response Syntax
{
  "status": "INVALID_ARGUMENT",
  "reason": "argument 'card_type': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample

results matching ""

    No results matching ""