메인 콘텐츠로 건너뛰기
ID check API는 기업 고객이 KYC(Know Your Customer)와 AML(Anti-Money Laundering) 프로세스를 체계적이고 효율적으로 관리할 수 있도록 설계된 RESTful API입니다.

주요 기능

ARGOS Identity KYC API는 다음과 같은 핵심 기능을 제공합니다
  • KYC 데이터 제출 및 관리: 고객 정보를 생성, 조회, 수정, 삭제할 수 있습니다.
  • AML 검사 요청 및 보고서 조회: AML 검사를 요청하고 결과를 확인할 수 있습니다.
  • 이미지 처리: 신분증 및 기타 필요 문서의 이미지를 업로드하고 관리할 수 있습니다.

API 엔드포인트

ARGOS Identity KYC API는 RESTful 아키텍처를 따르며, 다음과 같은 주요 엔드포인트를 제공합니다:

POST/Submission

KYC 데이터 제출

PATCH/Submission

KYC 데이터 수정

GET/Submission

KYC 데이터 조회

DELETE/Submission

KYC 데이터 삭제

PARTIAL-DELETE/Submission

KYC 데이터 컴포너트 삭제

REVIEW/Submission

Pending건 검수

GET/Image

이미지 조회

PUT/Image

이미지 업로드/수정

GET/Report/AML

AML 보고서 조회

POST/AML

AML 검사 요청

POST/AML Ongoing

AML 온고잉 모니터링 recordId 등록

GET/AML Ongoing

AML 온고잉 모니터링 recordId 조회

DELETE/AML Ongoing

AML 온고잉 모니터링 recordId 삭제

POST/Token

Private token 등록 요청

GET/Token

등록된 Private token 조회 요청

DELETE/Token

등록된 Private tokens 삭제 요청

GET/Projects

프로젝트의 설정 값 조회 요청

참고 사항

ID check API의 본질적 기능

우리의 ID check API는 ARGOS 시스템으로 들어오고 나가는 정보의 안전한 전송을 위한 파이프라인 역할을 하도록 설계되었습니다. 이를 안전한 파이프라인으로 생각하시면 됩니다: 외부 데이터를 ARGOS로 가져오거나, ARGOS에서 다른 애플리케이션에서 사용할 데이터를 추출할 수 있습니다. 주요 기능은 효율적인 데이터 이동으로, 정보가 필요한 곳으로 흐르도록 보장합니다.

데이터 처리 및 한계점

이 API들은 데이터 전송에는 뛰어나지만, 데이터 자체를 처리하거나 검증하지는 않습니다. 즉, POST submission API를 사용하여 ARGOS에 데이터를 보내거나 PUT Image API를 사용하여 이미지를 업로드해도, 시스템이 자동으로 결과를 승인하거나 거부하지는 않습니다. API는 전송을 용이하게 하지만, 후속 데이터 처리, 검증 또는 의사결정은 작동하지 않습니다.

자체 UI 구축을 위한 Verify 모듈

고객이 자체 UI를 통해 ID check의 기능을 활용하고 싶은 경우, Verify 모듈 사용을 권장합니다. Verify는 ARGOS의 기능을 API 형태로 제공하는 플렉서블한 도구입니다.
Verify 모듈 사용 시 고려사항
  • 내장 DB 없음: 자체 데이터베이스 구축 필요
  • 내장 프로세싱 없음: 모든 데이터 처리 로직을 직접 구현해야 함
  • 대시보드 없음: 제출 관리를 위한 웹 인터페이스 제공되지 않음
  • 완전한 자체 구성: 모든 기능 연결, 저장, 관리까지 고객이 직접 구성해야 함
클라이언트를 대상으로한 API 서비스 제공을 목표로 한다면, ARGOS Identity 측에서 통합/연동에 대한 지원을 제공할 의향이 있습니다. 더 자세한 내용은 Verify 시작하기 페이지를 참고해 주세요.

리전별 Base URL

프로젝트가 속한 리전의 호스트로 API를 호출해야 합니다. 각 API 페이지의 요청 예시는 US/KR 탭으로 전환해 확인할 수 있으며, 탭이 없는 예시는 호스트만 프로젝트 리전의 것으로 바꿔 사용합니다. 자세한 내용은 리전 안내를 참고하세요.

API 키

ID check API 키는 클라이언트 및 서버 요청을 확인하고 인증하는 역할을 해요. 요청자의 인증 정보를 확인하고 ARGOS Identity는 요청에 따른 올바른 응답을 내려줘요.
체험(Trial) 프로젝트는 API를 사용할 수 없습니다체험 프로젝트에는 API 키가 제공되지 않으며, 체험 프로젝트의 API 키로 보낸 요청은 모두 403으로 거절됩니다. 대시보드와 Liveform을 이용한 체험은 그대로 할 수 있습니다. API 연동을 테스트하려면 고객지원(customersupport@argosidentity.com)에 테스트(TEST) 프로젝트를 요청하세요. Unit API는 별도 키와 체험 한도로 이용할 수 있습니다.

API 키 확인하기

대시보드 설정의 API KEY 항목
1

대시보드 로그인

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

설정 메뉴 접근

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

Access Management 페이지 이동

좌측 사이드바의 General 섹션에서 Access Management를 선택합니다.
4

웹훅 URL 입력

API 키 섹션을 찾아 우측 아이콘을 클릭하여 API 키를 복사하고 보관합니다.
5

요청 헤더 구조

API 키 섹션을 찾아 우측 아이콘을 클릭하여 API 키를 복사하고 보관합니다.
6

API 통합 구현

테스트 환경에서 API 통합을 구현하고 테스트합니다.
7

프로덕션 환경으로 전환

프로덕션 환경으로 전환하여 실제 데이터 처리를 시작합니다.

응답 HTTP 상태 코드

HTTP 응답 코드를 통해 상태를 반환합니다. 각 응답 코드는 요청에 대한 결과를 나타내며, 아래와 같은 규칙을 따릅니다:
  • 2xx 성공적인 요청
  • 4xx 클라이언트 오류
  • 5xx 서버 오류
ARGOS Identity ID check API를 통해 KYC 및 AML 프로세스를 간소화하고, 규정 준수를 강화하며, 고객 온보딩 경험을 개선해보세요.

관련 문서

웹훅 이벤트

ARGOS ID check의 KYC 프로세스 상태 변경을 실시간으로 확인하세요. 웹훅을 통해 즉각적인 업데이트를 받아볼 수 있습니다.

GET/Submission 응답 필드 정의

GET/Submission API 응답에 포함되는 모든 필드에 대한 상세 정의

GET/Submission/applicantId

이 API를 사용하여 중복으로 제출된 KYC 데이터의 고유 식별 ID(submission_id)와 이메일을 조회할 수 있습니다. 중복 제출은 이름, 생년월일, 국적, 성별, 얼굴이 동일한 경우로 판단됩니다.