# 웹훅 (Webhook)

웹훅이란?

웹훅은 특정 이벤트가 발생한 경우 고객사 응용프로그램에게 이벤트에 대한 알림이 전달되는 기능을 의미합니다.

# 웹훅 등록 방법

웹훅 등록을 위해 이벤트를 받을 webhook URL을 아르고스팀에 전달해주십시오.

# 웹훅 트리거

Submission data는 입력 받은 정보만 리턴합니다. 예를 들어 submission 제출 시 cf1, wallet address등 optional 정보를 입력하지 않은 경우 해당 내용은 response에 포함되지 않습니다.

# 트리거 1: KYC 제출 완료시점

제출자가 KYC를 API 또는 폼을 통해 제출할 때 submission정보를 리턴합니다.

설명
email Email 주소
created_at 제출 일시
webhook_trigger submit
submission_id Submission ID
userid 고객사 고유의 KYC제출자 식별자 (≠ submission id)
SAMPLE RESPONSE
{
	"email":"test@argos-solutions.io",
	"created_at":"2020-08-27T11:47:17.345Z",
	"webhook_trigger":"submit",
	"submission_id":"1jrho7kecqsonc"
}

# 트리거 2: KYC 반려 시점

KYC가 반려되었을 때 kyc_result 정보 (거절 사유 포함), submission 정보를 리턴합니다.

설명
kyc_result KYC 결과
status rejected (반려)
comment 반려사유
updated_at 반려 시점
email Email 주소
webhook_trigger 트리거 (rejected)
submission_id Submission ID
userid 고객사 고유의 KYC제출자 식별자 (≠ submission id)
SAMPLE RESPONSE
{
	"kyc_result": {
		"status": "rejected",
		"comment": "The entered information does not match with your ID document.",
		"updated_at": "2020-06-02T05:19:49.685Z"
	},
	"email": "test@argos-solutions.io",
	"webhook_trigger": "rejected",
	"submission_id": "35sl57karv614s"
}

# Trigger 3: KYC 승인시점

KYC가 승인되었을 때 kyc_result정보, submission 정보를 리턴합니다.

설명
kyc_result KYC 결과
status rejected (승인)
updated_at 승인 시점
email Email 주소
webhook_trigger 트리거 (approved)
submission_id Submission ID
userid 고객사 고유의 KYC제출자 식별자 (≠ submission id)
SAMPLE RESPONSE
{
	"kyc_result":{
		"status":"approved",
		"updated_at":"2020-08-27 21:51"
	},
	"webhook_trigger":"approved",
	"email":"test@argos-solutions.io",
	"submission_id":"1jrho7kecqsonc"
}

# Trigger 4: AML 스크리닝 완료 시점

KYC 승인 후 AML Screening 절차가 완료되면 AML 결과와 submission 정보가 리턴됩니다. KYC가 거절된 경우에는 AML Screening을 하지 않습니다. KYC가 승인된 경우에만 AML Screening을 하여 결과가 리턴됩니다.

Parameter 설명
aml_result AML스크리닝 결과
currentstatus <Red Flagged, Not Screened>
Not Screened : AML데이터베이스상 일치하는 결과 없음
Red Flagged : AML데이터베이스상 일치하는 결과 있음
risk_level_summary (Not Screened, High, Medium, Low)
webhook_trigger aml
submission_id Submission ID
userid KYC제출자 식별을 위한 고객사 고유 커스텀 ID (String) (≠ submission id)

Sample Response 1: Red Flag

{
	"aml_result":{
		"currentstatus":"Red Flag",
		"risk_level_summary":"HIGH"
	},
	"webhook_trigger":"aml",
	"email":"test@argos-solutions.io",
	"submission_id":"22d4r08kedv2m4d"
}

Sample Response 2: Not Screened

SAMPLE RESPONSE
{
	"aml_result":{
		"currentstatus":"Not Screened",
		"risk_level_summary":"Not Screened"
	},
	"webhook_trigger":"aml",
	"email":"test@argos-solutions.io",
	"submission_id":"1jrho7alsdksonc"
}