메인 콘텐츠로 건너뛰기

​
FaceAuth에 접근하기 위한 QueryString

FaceAuth는 ID check의 하위 프로젝트로서 관리자는 원하는 만큼의 프로젝트를 생성할 수 있고, FaceAuth로 유저가 추가 인증을 받기 위해선 관리자는 Add-on 프로젝트 내의 Face Auth URL를 사용해야합니다.
셀피 사진이 존재하는 ID document나 Knowledge-based에서 승인 받은 submission_Id를 참조하기 위해선 QueryString을 통해 URL에 추가해야 하며, 보안을 위해 항상 암호화된 상태로 사용해야 합니다.
암호화는 FaceAuth 프로젝트 내의 API 키를 사용해야 하며, AES-256을 사용합니다.
자세한방법은 암호화 및 복호화 페이지의 쿼리 스트링 암호화를 확인하세요.
Face Auth URL
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}
Face Auth의 QueryString에서 기본: 참조할 submission_Id만 추가
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}&encrypted={sid={submission_Id}}
Face Auth의 QueryString에서 모든파라미터 추가: sid, authUserId, authCf1, authCf2, authCf3, token
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}&encrypted={sid={submission_Id}&authUserId={user Id}&authCf1={additional_info}&...&token={any tokenId}}
암호화 시켰을 때
  https://form.argosidentity.com/face-auth?pid={faceAuth_projectId}&encrypted={encrypted}

​
요청 파라미터들에 대한 정의

​
pid
string
required
FaceAuth 프로젝트 생성 시, 부여되는 프로젝트의 고유 번호 (URL에 자동적으로 붙여서 나옵니다.)
​
sid
string
required
ID document나 Knowledge-based를 통해서 승인 받은 submission_Id. (구분을 위해서 sid를 사용합니다.)
​
authUserId
string
관리자가 부여할 해당 유저의 유저 Id (관리자 서비스 내의 유저 Id가 될 수도 있고, ID document나 Knowledge-based에서 사용한 userId와 동일하게 부여할 수도 있습니다.)
​
authCf1
string
관리자가 추가로 부여할 해당 유저의 추가 정보들 (예: email 주소 등등)
​
authCf2
string
관리자가 추가로 부여할 해당 유저의 추가 정보들 (authCf1과 동일)
​
authCf3
string
관리자가 추가로 부여할 해당 유저의 추가 정보들 (authCf1과 동일)
​
token
string
보안을 위해서 관리자가 해당 url에 추가할 token 입니다.
주의사항!: 해당 token은 프라이빗 모드의 사전등록 token과는 별개로 작동됩니다.
Token은 사용자가 FaceAuth를 통해 인증할 때, 각 사용자에게 고유한 URL을 부여하기 위해 설계되었습니다.
Token을 적용하려면 FaceAuth 프로젝트에서 토큰 만료 조건 설정 옵션을 활성화해야 하며, 다음과 같은 방식으로 동작합니다.
  • 횟수 기반 만료: 토큰이 한 번 사용되면 해당 Token ID가 즉시 만료 처리됩니다.
  • 시간 기반 만료: 토큰이 한 번 사용된 시점을 기준으로 시간이 경과하면 해당 Token ID가 만료 처리됩니다.
이 토큰은 메인 프로젝트의 프라이빗 모드 토큰이나 사전 등록 토큰과는 별개로 동작합니다.
예를 들어, token에는 관리자가 설정한 임의의 tokenId를 지정할 수 있고, 메인 프로젝트에서 사용한 token을 재사용 하더라도 별개로 보기 때문에 작동됩니다. FaceAuth 프로젝트에서 토큰 만료 조건 설정 옵션을 활성화에 대한 가이드는 서비스 가이드의 애드온 - FACE AUTH를 참고하세요.
승인된 건 중, 셀피 사진이 존재하지 않는 경우에는 신분증의 초상화 이미지를 대신 사용합니다.

​
애드온 API 엔드포인트

POST/FaceAuth

Faceauth 제출

GET/FaceAuth

Faceauth 조회

GET/FaceAuth/Image

FaceAuth 이미지 조회

DELETE/FaceAuth

Faceauth 삭제

​
웹훅

Faceauth

FaceAuth 웹훅

​
API 키

Add-on API 키는 클라이언트 및 서버 요청을 확인하고 인증하는 역할을 하며 프로젝트의 API 키와는 다릅니다. 요청자의 인증 정보를 확인하고 아르고스 아이덴티티는 요청에 따른 올바른 응답을 내려줍니다.

​
애드온 API 키 확인하기

1

대시보드 로그인

ID Check 대시보드에 로그인합니다.
2

설정 메뉴 접근

대시보드 상단 네비게이션 바에서 애드온 메뉴를 클릭합니다.
3

프로젝트 생성

애드온 페이지에서 프로젝트 생성 버튼을 클릭 후 프록젝트를 생성합니다.
4

API 키 확인

프로젝트 생성 후 애드온 페이지의 수정 버튼을 클릭 후 API키 를 확인합니다. API 키 섹션을 찾아 우측 아이콘을 클릭하여 API 키를 복사하고 사용합니다.

​
응답 HTTP 상태 코드

HTTP 응답 코드를 통해 상태를 반환합니다. 각 응답 코드는 요청에 대한 결과를 나타내며, 아래와 같은 규칙을 따릅니다:
  • 2xx 성공적인 요청
  • 4xx 클라이언트 오류
  • 5xx 서버 오류
HTTP 상태 코드메시지설명
200OK요청이 성공적으로 처리되었습니다.
400Invalid Query String parameters요청을 처리할 수 없습니다. 필수 파라미터가 누락되었거나, 파라미터 형식이 잘못되었습니다. 요청 파라미터를 다시 확인해 주세요.
403User is not authorized to access this resource with an explicit deny권한이 없습니다. IP 화이트리스트에 등록되지 않은 IP에서 접근했습니다.
403Forbidden권한이 없습니다. 잘못된 API 키를 사용했을 수 있습니다.
413Request Entity Too Large요청이 너무 큽니다. 서버에서 처리할 수 있는 크기를 초과한 데이터가 포함된 요청입니다. 요청 데이터를 축소해 다시 시도해 주세요.
500Internal Server Error서버 오류가 발생했습니다. 아르고스 서버에서 문제가 발생했을 수 있습니다. 이 경우 아르고스 팀에 문의해 주세요.
502Bad Gateway서버가 업스트림 서버로부터 잘못된 응답을 받았습니다. 잠시 후 다시 시도하거나, 아르고스 팀에 문의해 주세요.