POST
/
search
Search face in collection
curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "collectionId": "col_123456789",
  "faceImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."
}'
{
  "message": "Search completed successfully",
  "result": [
    {
      "face_id": "<string>",
      "user_name": "<string>",
      "similarity_score": 123
    }
  ]
}
이 API 엔드포인트를 통해 제출된 이미지를 사용하여 컬렉션 내에서 일치하는 얼굴을 검색할 수 있습니다. 이 기능은 얼굴 인식 및 신원 확인 애플리케이션에서 매우 유용합니다.

​
요청

​
헤더

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

​
본문 매개변수

​
collectionId
string
required
검색할 컬렉션의 고유 식별자입니다.
​
faceImage
string
required
검색할 얼굴 이미지의 Base64 인코딩된 문자열 표현입니다.

​
응답

​
성공 응답 (200)

​
message
string
얼굴 검색 결과를 나타내는 성공 메시지
​
result
array
일치하는 얼굴 객체의 배열:face_id: 일치하는 얼굴의 고유 식별자user_name: 일치하는 얼굴과 관련된 사용자의 이름similarity_score: 검색된 얼굴과 일치하는 얼굴 간의 유사성 점수

​
오류 응답

​
잘못된 요청 (400)

​
errorCode
number
문제 해결을 위한 특정 오류를 식별합니다:
  • 6035: CollectionId가 필요합니다
  • 6036: FaceImage가 필요합니다
  • 6037: 컬렉션 정보를 찾을 수 없습니다
  • 6038: 얼굴 검색 실패
​
message
string
오류에 대한 간략한 설명입니다. 자세한 내용은 오류 코드를 참조하세요.

​
금지됨 (403)

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

Authorizations

​
x-api-key
string
header
required

Body

application/json

Response

200
application/json

Face search completed successfully

The response is of type object.