GET/FaceAuth

Input Data

• 반드시 Header에 Add On 전용 API-Key를 실어서 전송해야 합니다. (필수)

• 특정 제출 건 (단 건) 조회 시 해당 Authentication ID를 제출해야 합니다. Authentication Id 미제출 시 전체 리스트가 조회됩니다.

• 특정 기간 내의 리스트 조회 시 반드시 startDate와 endDate를 모두 제출해야 하며, 형식은 yyyy-mm-dd 입니다.

• 1회 요청 시 조회할 제출 건의 개를 ‘count’ 를 통해 지정할 수 있습니다. 1 ~ 2,000 범위 내 지정 가능하며 미제출 시 기본값 2,000건으로 적용됩니다.

• 1회 요청 시 최대 조회 가능 개수는 2,000건이며, 더 조회할 데이터가 있을 시 ‘nextPage_key’ 객체가 함께 반환됩니다. 이어서 조회할 때는 ‘nextPage_key’ 객체 내 ‘authId’를 ‘nextKey_id’로, ‘createTime’을 ‘nextKey_date’로 요청 파라미터에 전송합니다.

Parameter	Format	requirement	Description
authId	string	optional	-authId 제출: 단 건 조회 -authId 미제출: 해당 faceAuth_project 내 전체 제출 건 리스트 조회
startDate	string	optional	조회 시작 일자 (yyyy-mm-dd)
endDate	string	optional	조회 종료 일자 (yyyy-mm-dd)
nextKey_id	string	optional	앞선 요청의 Response 내 nextPage_key 객체의 ‘authId’
nextKey_date	string	optional	앞선 요청의 Response 내 nextPage_key 객체의 ‘createTime’
count	number	optional	조회할 데이터 건 수 (최소 1 ~ 최대 2000), 미제출 시 기본값 2000건

Output Data

Properties	Format	description
faceAuth_projectId	string	faceAuth project ID
data	array	조회된 제출건을 포함한 배열
data[i]	object	각 제출건 객체
data[i].auth_id	string	각 제출건의 고유 ID (authentication ID)
data[i].auth_status	string	인증 결과
data[i].create_time	string	제출 시각
data[i].submit_type	string	제출 방식
data[i].kyc_submission_id	string	faceAuth 를 진행한 KYC 제출건의 ID
data[i].policy	object	인증에 적용된 임계치 정책 객체
data[i].policy.faceSimilarity_threshold	number	얼굴 유사도 임계값
data[i].policy.faceCover_threshold	number	안면 보호구 임계값
data[i].policy.headCover_threshold	number	안전모 착용 임계값
data[i].policy.occluded_threshold	boolean	얼굴 가림 여부
data[i].delete_check	boolean	삭제 데이터 여부
data[i].delete_time	string	삭제 시각

Request URL

curl -X GET "https://rest-api.argoskyc.com/v3/faceauth" \
-H "x-api-key: {yourAPIKey}" \

Sample Response - delete_check: false

[
        {
            auth_id : "sampleId1", 
			aurh_status : "approved",
			create_time : "2023-08-18T15:00:00.000Z",
			submit_type : "sampleType",
			kyc_submission_id : "sampleKycId1",
			policy : {
				faceSimilarity_threshold : 70,
				occluded_threshold : false, 
				faceCover_threshold : 0,
				headCover_threshold : 50
			},
            "delete_check": false
        },
]

Sample Response - delete_check: true

[     
       { 
            auth_id : "sampleId1", 
			aurh_status : "approved",
			create_time : "2023-08-18T15:00:00.000Z",
			submit_type : "sampleType",
			kyc_submission_id : "sampleKycId1",
			policy : {
				faceSimilarity_threshold : 70,
				occluded_threshold : false, 
				faceCover_threshold : 0,
				headCover_threshold : 50
			},
            "delete_check": true,
            "delete_time": "2023-09-04T02:19:01.399Z"
        },
]

Error Code

400 Error

• Face Auth 에서 제출에 실패가 되면 실패한 이유에 대한 에러 코드와 함께 메세지가 제공됩니다.

Message	description
faceAuth_project not found	제출한 API-Key 에 대해 유효한 프로젝트가 존재하지 않을 경우 발생. API-Key 를 확인해주세요.