Call this API to query the aggregated health status of recent Non-Document Verification traffic for a given numberType. Use it for circuit breaking, degradation, or routing decisions before starting a new verification flow.

This API does not return the result of a specific signatureId. To retrieve a single transaction result, use Get Result API.

Request Example:

curl -X GET \
  'https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/non-doc-health-status?numberType=NG_BVN' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}'

Request Url

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/non-doc-health-status
GET

Request Header Parameters

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token

Request Parameters

Parameter	Description
numberType	`string` Required. The health-check identifier. Must be one of the enum names in the table below (case-insensitive). This is not the same value as `numberType` in Generate URL API (for example, use `NG_BVN`, not `BVN`).

numberType values

Health Status API `numberType`	Generate URL `numberType`	Region
NG_BVN	BVN	NGA
NG_NIN	NIN	NGA
ID_NIK	NIK	IDN
BR_CPF	CPF	BRA
US_NATIONALID	NATIONALID	USA
GB_GB	GB	GBR

Note: AADHAAR-PAN (IND) from Supported Regions & NumberTypes is not supported by this API and returns PARAMETER_ERROR.

Response Description

Parameter	Description
code	Response Code of this API call
transactionId	The request id, the max length is 64
pricingStrategy	`Deprecated`, Always return `FREE`
message	Status Code Explanation
data	`object` Health status result. See Response.data
extra	Extra response info (Exception Message)

Response.data

Field	Description
numberType	`string` Echo of the query enum name, for example `NG_BVN`
status	`string` Aggregated health status. See Response.data.status

Response.data.status

status	Description	Suggested action
health	Recent sample volume is sufficient and the error rate is low	Continue with Non-Doc verification
unstable	Elevated error rate (≥ 10% and < 50%, with minimum sample and error thresholds met)	Alert or degrade
offline	High error rate (≥ 50%, with minimum sample and error thresholds met)	Circuit break or switch to a fallback
nodata	Fewer than 10 samples in the evaluation window	Do not treat as vendor outage; insufficient data

Important

When data.status is offline or unstable, HTTP status is still 200 and top-level code is still SUCCESS.

data.status describes vendor health; code describes whether this API call succeeded.

Status is derived from recent Non-Doc verification traffic (including delayed failure accounting), not from an active probe call.

Response Code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Parameter error, please check your request whether has illegal parameters
ERROR	Server internal error, please retry later

Authentication failures (for example invalid or expired token) follow the same codes as other Identity Risk APIs. Refer to Token Authentication API.

Response Examples

SUCCESS (health)

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "numberType": "NG_BVN",
    "status": "health"
  },
  "extra": null,
  "transactionId": "a1b2c3d4e5f67890",
  "pricingStrategy": "FREE"
}

SUCCESS (nodata)

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "numberType": "NG_BVN",
    "status": "nodata"
  },
  "extra": null,
  "transactionId": "b2c3d4e5f6789012",
  "pricingStrategy": "FREE"
}

PARAMETER_ERROR

{
  "code": "PARAMETER_ERROR",
  "message": "Parameter error, please check your request whether has illegal parameters",
  "data": null,
  "extra": null,
  "transactionId": "c3d4e5f678901234",
  "pricingStrategy": "FREE"
}