id info

2025-06-05 07:32

Overview

API URL：/api/v1/zoloz/info/idlist
API Description: The idlist API is used to request the list of ID documents supported by ZOLOZ.

Structure

Request parameters

Response parameters

Field name

Data type

Description

Example

result

Result

Required. The API result, which contains information about the result of the API request, such as status and error codes.

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

data

Map<String, IdInfo>

Optional.

Detailed information about id info：

key is docType
value is IdInfo. Please refer to data structure of IdInfo for more information.

{

"00650000002": {

"country": "Singapore",

"docName": "Singapore PR Card",

"countryCode": "SGP",

"docType": "00650000002"

"00650000001": {

"country": "Singapore",

"docName": "Singapore Citizen Card",

"countryCode": "SGP",

"docType": "00650000001"

}

IdInfo

Field name	Type	Description	Example
country	String	Optional. County name, if there is no corresponding country (e.g., Generic Passport), return "Default."	"Singapore"
countryCode	String	Country code, following the ISO 3166-1 alpha-3 standard. If there is no corresponding country (e.g., Generic Passport), return an empty string.	"SGP"
docType	String	Id type	"00650000002"
docName	String	The name of the id card	"Singapore PR Card"

Result

Result process logic

For different request results, different actions are to be performed. See the following for details:

If the value of the result.resultStatus is S, the ZOLOZ id info API is invoked successfully, and results about id info are returned.
If the value of the result.resultStatus is F, the invocation of the ZOLOZ id info API fails. Check the error code and message for more information about the possible reasons. Error codes.

Common result codes

For the full list of common result codes, see the Common result codes section in the Error handling topic.

API-specific result codes

The following table shows the possible result codes that are specific for the id info API.

resultCode	resultSatus	Description
SUCCESS	S	User finished the transaction.
SYSTEM_ERROR	F	Other internal errors. For more information about the error details, check the result message or the related log.

Sample

Request Sample

The following sample shows what a request that the merchant server sends looks like.

copy
POST /api/v1/zoloz/info/idlist HTTP/1.1
{}

Response Sample

The following sample shows what a response that the ZOLOZ server returns looks like.

copy
{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "Success"
  },
  "data": {
    "00650000002": {
      "country": "Singapore",
      "docName": "Singapore PR Card",
      "countryCode": "SGP",
      "docType": "00650000002"
    },
    "00650000001": {
      "country": "Singapore",
      "docName": "Singapore Citizen Card",
      "countryCode": "SGP",
      "docType": "00650000001"
    }
  }
}