# Webhook

Webhook provides real-time notifications when specific events occur.

# Webhook Integration

To integrate webhook, please send your webhook URL to your Argos Representative.

# Webhook Triggers

"Submission data" only returns entered information. In cases where you do not include any optional information such as "cf1" or "wallet_address" in submission data, the response object does not include them either.

# Trigger 1: When a KYC submission is made

KYC submission data is returned when the KYC submission process is complete.

Parameter Description
email Email address
created_at Time when a KYC submission is complete
webhook_trigger submit
submission_id Submission ID
userid Unique ID for each KYC applicant (≠ submission id)
SAMPLE RESPONSE
{
	"email":"test@argos-solutions.io",
	"created_at":"2020-08-27T11:47:17.345Z",
	"webhook_trigger":"submit",
	"submission_id":"1jrho7kecqsonc"
}

# Trigger 2: When a KYC application is rejected

KYC submission data is returned when KYC is rejected.

Parameter Description
kyc_result KYC result
status rejected
comment Detailed reason of KYC rejection
updated_at Time when KYC is rejected
email Email address
webhook_trigger rejected
submission_id Submission ID
userid Unique ID for each KYC applicant (≠ 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: When a KYC application is approved

KYC submission data is returned when KYC is approved.

Parameter Description
kyc_result KYC result
status approved
updated_at Time when KYC is approved
email Email address
webhook_trigger approved
submission_id Submission ID
userid Unique ID for each KYC applicant (≠ 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: When AML screening is complete

AML result and submission data are returned when AML screening is complete.

Parameter Description
aml_result AML screening result
currentstatus Not Screened: no match found in AML database
Red Flag : Search result matched with match found in AML database
risk_level_summary (Not Screened, High, Medium, Low)
matches Detailed AML screening result on red-flagged group
risk_level Risk level (HIGH, MEDIUM, LOW)
risk_icon Identified risk categories (PEP, Current Sanctions, Law Enforcement, Financial Regulator, PEP by association, Previous Sanctions, Adverse Media, Disqualified Director, Insolvency)
argos_number Argos aml reference number
webhook_trigger aml
submission_id Submission ID
userid Unique ID for each KYC applicant (≠ submission id)

Sample Response 1: Red Flag

{
	"aml_result":{
		"currentstatus":"Red Flag",
		"risk_level_summary":"HIGH",
		"matches":[{
			"risk_level":"HIGH",
			"argos_number":214221,
			"risk_icons":[
				"Adverse Media",
				"Corporate/Business",
				"Insolvent",
				"ID/V",
				"PEP",
				"Law Enforcement"
			]
		}]
	},
	"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"
}