ZOLOZZOLOZDOCS

id info

概览

  • API URL：/api/v1/zoloz/info/idlist
  • API 描述：该接口用于获取ZOLOZ支持的证件列表信息。

请求参数

无

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

API请求结果，包含结果状态、结果码和结果消息。

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

data

Map<String, IdInfo>

否

返回的证件信息详情。data由一个键值对组成：

  • 键为docType。
  • 值为IdInfo，详见IdInfo数据结构。

{

"00650000002": {

"country": "Singapore",

"docName": "Singapore PR Card",

"countryCode": "SGP",

"docType": "00650000002"

},

"00650000001": {

"country": "Singapore",

"docName": "Singapore Citizen Card",

"countryCode": "SGP",

"docType": "00650000001"

}

}

IdInfo类型说明

字段名称

数据类型

必须返回

描述

示例值

country

String

否

证件所属国家。如果没有对应国家（例如通用护照），则返回Default。

"Singapore"

countryCode

String

否

证件所属国家代码，遵循ISO 3166-1 alpha-3标准。如果没有对应国家（例如通用护照），则返回空字符串。

"SGP"

docType

String

否

证件类型。

"00650000002"

docName

String

否

证件名称。

"Singapore PR Card"

处理结果

根据请求结果执行下一步的响应动作，具体如下：

  • 当result.resultStatus的值为S时，表示调用ZOLOZ id info API成功，并返回证件信息相关结果。
  • 当result.resultStatus的值为F时，表示调用ZOLOZ id info API失败。请检查错误码获取有关该错误的更多信息，并分析导致该错误的原因。

API通用结果码

有关通用结果码的完整列表，请参见API通用结果码。

API特有结果码

id info API的结果码见下表。

结果码

结果状态

描述

SUCCESS

S

API调用成功。

SYSTEM_ERROR

F

其他内部错误。有关错误详情，请查看返回的resultMessage。

代码示例

请求示例

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

返回示例

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"
    }
  }
}