Retrieve User Information

Request Path

/open/api/user/core/queryUserInfo

Request Method

POST

Parameter Description

Parameter Name	Required	Type	Description	Length	Example
userNum	Yes	string	User number	64	100516923407528221713
merchantNo	No	string	Merchant number	64	NFT0001
subMerchantNo	No	string	Sub-merchant number	64	a01a123
businessSubcategories	No	string	Business subcategories	32	VSR

Request Example

JSON

{
    "userNum": "100516923407528221713",
    "merchantNo": "NFT0001",
    "subMerchantNo": "a01a123",
    "businessSubcategories": "VSR"
}

Response Parameters

Parameter Name	Type	Description
userNum	List	User number
documentInfoList	List	List of user documents
addressInfoList	List	List of user addresses
nameHistoryInfoList	List	List of user name records
extendInfoList	List	List of user extended information

User Document List [UserDocumentInfoResponse]

Parameter Name	Type	Description	Example
firstName	string	First name	John
lastName	string	Last name	Doe
idDocType	string	Document type (1=ID Card, 2=Passport, 3=RESIDENCE_PERMIT, 4=DRIVERS)	1
validUntil	string	Valid until	2025-06-04
dob	string	Date of birth	2000-06-04
number	string	ID card number / permit number / passport number	130929199003016238
additionalNumber	string	Additional document number	null
facePhoto	string	Face photo link	http://***/photo.png
documentPhoto	string	Document photo link	http://***/document.png
documentBackPhoto	string	Document back photo link	http://***/back_document.png
sourcePlatform	string	Source (1: Sumsub, 2: Jumio, 3: Persona)	1

User Address List [UserAddressInfoResponse]

Parameter Name	Type	Description	Example
country	string	Country	United States
street	string	Street	null
city	string	City	null
state	string	State	null
zipCode	string	Zip code	null
address	string	Address	null
sourcePlatform	string	Source (1: Sumsub, 2: Jumio, 3: Persona)	1
createTime	string	Creation time	2023-08-18T06:39:12.000+0000

User Name History List [UserHistoryInfoResponse]

Parameter Name	Type	Description	Example
firstName	string	First name	John
lastName	string	Last name	Doe
gender	string	Gender	null
createTime	string	Creation time	2023-08-18T06:39:13.000+0000

User Extended Information List [UserExtendInfoResponse]

Parameter Name	Type	Description	Example
extendKey	string	Extended key	name
extendValue	string	Extended value	John
describes	string	Description	Name

Response Example

{
  "code": "0",
  "msg": "SUCCESS",
  "model": {
    "userNum": "100516923407528221713",
    "documentInfoList": [
      {
        "firstName": "XX",
        "lastName": "X",
        "idDocType": "1",
        "validUntil": "2025-06-04",
        "dob":"2000-06-04",
        "number": "130929199003016238",
        "additionalNumber": null,
        "facePhoto": null,
        "documentPhoto": null,
        "documentBackPhoto": null,
        "sourcePlatform": "1"
      }
    ],
    "addressInfoList": [
      {
        "country": "AMERICA",
        "street": "",
        "city": null,
        "state": null,
        "zipCode": null,
        "sourcePlatform": "1",
        "createTime": "2023-08-18T06:39:12.000+0000"
      }
    ],
    "nameHistoryInfoList": [
      {
        "firstName": "XX",
        "lastName": "X",
        "gender": null,
        "createTime": "2023-08-18T06:39:13.000+0000"
      },
      {
        "firstName": "fghjfghe",
        "lastName": "gjng",
        "gender": null,
        "createTime": "2023-08-18T08:25:41.000+0000"
      },
      {
        "firstName": "X",
        "lastName": "X",
        "gender": null,
        "createTime": "2023-08-18T10:14:46.000+0000"
      }
    ],
    "extendInfoList": [
      {
        "extendKey": "name",
        "extendValue": "1",
        "describes": "name"
      },
      {
        "extendKey": "age",
        "extendValue": "1",
        "describes": "age"
      }
    ]
  },
  "traceId": "64e879ab20d696d4461b0c222f09fa1d",
  "success": true,
  "error": false
}