DELETE/Submission

주의사항

삭제된 제출 건은 복원할 수 없습니다.
삭제된 제출 건도 과금 대상에 포함됩니다.
삭제된 제출 건은 대시보드 및 GET/API Response에 ‘삭제된 제출건’으로 표시됩니다.
이 API를 사용할 때는 신중을 기해야 합니다. 실수로 중요한 데이터를 삭제하지 않도록 주의하세요.

1. 엔드포인트

DELETE https://rest-api.argosidentity.com/v3/submission

DELETE https://kr.rest-api.argosidentity.com/v3/submission

2. 인증

x-api-key 헤더에 API 키를 포함시켜야 합니다:

x-api-key

x-api-key: {yourAPIKey}

3. 요청 파라미터

string

필수

삭제할 제출 건의 고유 ID

string

삭제를 진행한 관리자의 이메일

admin_name 파라미터는 선택이나, 삭제 이후에 웹훅 수신을 원할 시에는 admin_name 파라미터와 함께 호출하셔야 합니다.

3-1. 삭제되는 데이터

개인 신원정보(이름, 생년월일, 성별, 국적 등)
신분증 민감정보(Document number, Serial number, Barcode 등)
이미지 파일(신분증 이미지, 셀피)
AML 정보(AML 옵션 사용 시 저장된 데이터)

3-2. 유지되는 데이터

제출 건 고유 ID(Submission ID), 제출일자, 신분증 유형, ID check 승인 여부 등 개인을 특정할 수 없는 기본 데이터만 유지됩니다.

4. 요청 예시

bash Request
curl --location --request DELETE 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}&admin_name={admin_name}' \
--header 'x-api-key: {yourAPIKey}'

bash Request
curl --location --request DELETE 'https://kr.rest-api.argosidentity.com/v3/submission?submission_id={submission_id}&admin_name={admin_name}' \
--header 'x-api-key: {yourAPIKey}'

5. 응답

5-1. 성공 응답

result.json

{
    "message": "success",
    "content": "Submission {submissionID} deleted successfully.",
    "statusCode": 200
}

5-2. 오류 응답

오류가 발생하면 400 상태 코드와 함께 응답 본문에 세부 정보가 포함됩니다:

error.json

{
    "message": "not Exist Submission ID",
    "statusCode": 400
}

5-3. 오류 코드

오류 코드	설명
`not Exist Submission ID`	`submission_id`가 누락됨
`not Exist Submission Data`	해당 `submission_id`의 데이터가 존재하지 않음
`not Exist Project Data`	프로젝트 정보가 존재하지 않음
`delete Process FAIL`	삭제 프로세스 실패 (메타 페이스 ID 삭제 실패 등)

시작하기

‘ID check API는 기업 고객이 KYC(Know Your Customer) 및 AML(Anti-Money Laundering) 프로세스를 보다 체계적이고 효율적으로 관리할 수 있도록 설계된 솔루션입니다. 이 API는 기존 시스템과의 원활한 통합을 지원하며, 사용자 데이터를 안전하게 처리하고 관리할 수 있는 기능을 제공합니다.

GET/Submission 응답 필드 정의

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

웹훅 이벤트

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

개요

API 참조

1. 엔드포인트

2. 인증

3. 요청 파라미터

3-1. 삭제되는 데이터

3-2. 유지되는 데이터

4. 요청 예시

5. 응답

5-1. 성공 응답

5-2. 오류 응답

5-3. 오류 코드

관련 문서

시작하기

GET/Submission 응답 필드 정의

웹훅 이벤트

​1. 엔드포인트

​2. 인증

​3. 요청 파라미터

​3-1. 삭제되는 데이터

​3-2. 유지되는 데이터

​4. 요청 예시

​5. 응답

​5-1. 성공 응답

​5-2. 오류 응답

​5-3. 오류 코드

​관련 문서

시작하기

GET/Submission 응답 필드 정의

웹훅 이벤트

1. 엔드포인트

2. 인증

3. 요청 파라미터

3-1. 삭제되는 데이터

3-2. 유지되는 데이터

4. 요청 예시

5. 응답

5-1. 성공 응답

5-2. 오류 응답

5-3. 오류 코드

관련 문서