GET
/
faces
Get list of faces in collection
curl --request GET \
  --url https://idverify-api.argosidentity.com/modules/faces \
  --header 'x-api-key: <api-key>'
{
  "message": "Faces retrieved successfully",
  "result": [
    {
      "collection_id": "<string>",
      "face_id": "<string>",
      "user_name": "<string>",
      "create_time": "<string>",
      "meta_face_id": "<string>"
    }
  ],
  "totalCount": "<string>"
}
이 API 엔드포인트를 통해 특정 컬렉션 내에 포함된 모든 얼굴의 목록을 검색할 수 있습니다. 페이지네이션 및 검색 기능을 사용하여 대용량 얼굴 데이터 컬렉션을 효율적으로 관리할 수 있습니다.

​
요청

​
헤더

​
x-api-key
string
인증 및 접근 제어에 사용되는 API 키입니다. 이 헤더 매개변수는 인증에 필요합니다.

​
쿼리 매개변수

​
collectionId
string
required
얼굴이 추가될 컬렉션의 고유 식별자입니다.
​
page
string
required
페이지네이션을 위한 페이지 번호입니다. 반복당 50개의 데이터를 반환합니다.
​
term
string
특정 문자열을 포함하는 faceIds 목록을 검색합니다. (최소 5자 이상이어야 함)

​
응답

​
성공 응답 (200)

​
message
string
결과를 나타내는 성공 또는 오류 메시지
​
result
array
다음을 포함하는 얼굴 객체의 배열:collection_id: 얼굴 컬렉션의 고유 식별자face_id: 컬렉션 내 얼굴의 고유 식별자user_name: 얼굴과 관련된 사용자의 이름create_time: 얼굴이 추가된 타임스탬프meta_face_id: 얼굴의 메타데이터 식별자
​
totalCount
string
검색 조건과 일치하는 총 얼굴 수를 나타냅니다. 이 예에서는 하나의 얼굴만 발견되었지만, 더 많은 일치 항목이 감지되면 이 값이 더 높을 수 있습니다.

​
오류 응답

​
잘못된 요청 (400)

​
errorCode
number
문제 해결을 위한 특정 오류를 식별합니다:
  • 6024: CollectionId가 필요합니다
  • 6025: Term 문자열이 5자 미만입니다
  • 6026: Page가 누락되었습니다
  • 6027: 컬렉션 정보가 존재하지 않습니다
  • 6028: 이 컬렉션은 사용할 수 없습니다
  • 6029: 얼굴 목록 가져오기 실패
​
message
string
오류에 대한 간략한 설명입니다. 자세한 내용은 오류 코드를 참조하세요.

​
금지됨 (403)

​
errorCode
number
문제 해결을 위한 특정 오류를 식별합니다:
  • 6039: API 키가 필요합니다
  • 6040: 액세스 거부: API 키를 사용할 수 없습니다
​
message
string
오류에 대한 간략한 설명입니다. 자세한 내용은 오류 코드를 참조하세요.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
collectionId
string
required

Unique identifier of the collection

​
page
string
required

Page number for pagination. Returns 50 pieces of data per iteration

​
term
string

Retrieves a list of faceIds containing a specific string. (Must be at least 5 characters long)

Response

200
application/json

List of faces retrieved successfully

The response is of type object.