Call the getPersonInfo operation to query the details of an individual registered in the face recognition library, including the individual's name, associated face image IDs, and individual group memberships.
Rate limits
This operation supports up to 20 calls per second per account. Exceeding this limit triggers throttling, which may affect your business.
Request syntax
POST /green/sface/person HTTPS|HTTPRequest headers
This operation uses only common request headers.
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| clientInfo | JSONObject | No | {"userId":"120234234","userNick":"Mike","userType":"others"} | The client information serialized from the ClientInfo structure in JSON format. Includes the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo. |
Request body
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| personId | String | Yes | person1 | The ID of the individual to query. |
Response parameters
All responses are returned in JSON format. For common response parameters, see Common response parameters.
The data field contains the following parameters.
Note: The data field may be empty if an error occurs.| Parameter | Type | Example | Description |
|---|---|---|---|
| code | Integer | 200 | The HTTP status code. For more information, see Common error codes. |
| personId | String | person1 | The ID of the individual. |
| name | String | Tom | The name of the individual. |
| groupIds | StringArray | ["group1","group2"] | The IDs of the individual groups to which the individual belongs. |
| faceIds | StringArray | ["1234999323333","124556455466"] | The IDs of the face images associated with the individual. |
| note | String | Male | The description of the individual. |
Examples
Request example
POST /green/sface/person HTTP/1.1
<Common request headers>
{
"personId": "person1"
}Response example
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"name": "Tom",
"groupIds": [
"group1",
"group2"
],
"faceIds": [
"1234999323333",
"124556455466"
],
"note": "Male"
}
}