Links

GET/Submission

Request URL

curl -X GET "https://rest-api.argoskyc.com/v3/submission?submission_id={submission_id}"\
-H "x-api-key: {yourAPIKey}"
Get a list of submissions.
  • The KYC / AML status can be checked by the GET request.
  • You can either check for the KYC status of a specific submission or get a list of KYC submissions with GET request.
  • If no parameter is provided, a list of all submissions is returned.
  • If a parameter is provided, filter the list by the given parameter.
  • To get a submission data of a specific submission, submission id must be provided as a parameter. Please refer to the Input Data table for detail.

Input Data

* means required parameters. (Get submission has no required parameters.)
Parameter
Description
submission_id
Submission ID. A single submission data matching the submission ID is returned.
userid
A list of submissions matching the userid is returned. The userid is an optional parameter that is inserted into submission data when posting a submission.
email
A list of submissions matching the email address is returned.
count
The number of data to be transmitted when requesting a list output(maximum of 2,000). When requesting a list without a count parameter, up to 2,000 will be the output by default.
nextpage_id
If 'nextpageKey' is returned to the response when requesting list output, it means that there is a next page. To call the next page, 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.created_at) should be included to the request parameter.
nextpage_date
If 'nextpageKey' is returned to the response when requesting list output, it means that there is a next page. To call the next page, 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.created_at) should be included to the request parameter.
start_date
Start date of querying period(YYYYMMDD)
end_date
End date of querying period(YYYYMMDD)
request_type
Selectively query certain items. Available options are { kyc, aml, data, others }
  • aml: aml. sub data + submission_id
  • kyc: kyc. sub data + submission_id
  • data: data. sub data + submission_id
  • others: Rest of the data except for aml, kyc, data.

Output Data

Response
Description
data
KYC applicant data
data.name
name
data.gender
<male, female>
data.nationality
Three letter format (ISO alpha3 format) of nationality.
data.date_of_birth
YYYY-MM-DD format of date of birth
data.ip_address
User's IP address in IPv4 format
data.idType
ID card type
<passport, government_id, drivers_licensem, residence permit, vehicle registration certificate, visa, aadhaar, pancard>
data.idcard_issuingCountry
ISO alpha 3 format country code where ID card is issued.
data.idcard_issueDate
YYYY-MM-DD format of ID card issue date
data.idcard_expireDate
YYYY-MM-DD format of ID card expiry date
data.identityNumber
Personal Identity Number
data.documentNumber
Documnet number
data.address_city
City
data.address_country
Country
data.address_state
State
data.address_street
Street
data.address_zipcode
Zip code (postal code)
data.address_globalCode
Detailed code from the address (ex. 87C4VXX7+39)
data.address_compoundCode
Detailed code, city and country from the address (ex. VXX7+39 Washington, DC, USA)
data.address_formatted
Transformed address from detailed code
data.address_input
User input address
data.address_detail
User input detailed address
data.cf1
Optional parameter that is inserted into submission data when posting a submission.
data.cf2
Optional parameter that is inserted into submission data when posting a submission.
data.cf3
Optional parameter that is inserted into submission data when posting a submission.
email
email address
reviewer
system: when reviewed by AI agent: when reviewed by human
submission_id
Identifier given to each submission
applicant_id
Identifier given to duplicated applicant
created_at
KYC submitted date and time.
kyc_result_at
Time when the KYC result is first determined, it will be transmitted only when the result is 'approved/rejected'. (UTC+0)
updated_at
The most recent time when the submission was updated. (UTC+0)
pending_at
Time when a submission was turned into 'pending' status. (UTC+0)
userid
Optional parameter that is inserted into submission data when posting a submission.
kyc
KYC data object
kyc.result
<incomplete, pending, approved, rejected> incomplete: KYC submission is incomplete due to insufficient data.
pending: the submission is under manual review
approved: submission is approved
rejected: submission is rejected. Reject comment can be found at "kyc.comment".
KYC reject comment is returned only when KYC result is 'rejected'
Code for KYC reject comment
kyc.attempts
Object of Liveness, Detect face, Face compare
kyc.attempts[i].attemptCnt
Sum of attempts tried at Step 1 and Step 2
kyc.attempts[i].idBarcodeResult
Barcode verification result for USA, CAN, MEX ID
kyc.attempts[i].verificationResult
Authentication result on attempt [i] <success, fail>
kyc.attempts[i].verification
Detail data of authentication on attempt [i]
kyc.attempts[i].verificationParams
Authentication data on attempt [i]
kyc.attempts[i].errorCode
Liveness, Detect face, Face compare, Authentication error code
kyc.attempts[i].errorMsg
Liveness, Detect face, Face compare, Authentication error message
kyc.attempts[i].step1Time1st
Step1 API 1st call time
kyc.attempts[i].step1Time2nd
Step1 API 2nd call time
kyc.attempts[i].step1Time3rd
Step1 API 3rd call time
kyc.attempts[i].step2Time1st
Step2 API 1st call time
kyc.attempts[i].step2Time2nd
Step2 API 2nd call time
kyc.attempts[i].step2Time3rd
Step3 API 3rd call time
kyc.attempts[i].retryMsg
Cause of rejection on Liveness, Detect face, Face compare, Authentication(Korean)
kyc.attempts[i].retryCode
Code of cause for rejection on Liveness, Detect face, Face compare, Authentication(Korean)
kyc.attempts[i].faceSimilarityScore
Face similarity score on attempt [i]
kyc.attempts[i].selfieImage
Selfie image URL of attmept [i]
kyc.attempts[i].livenessScore
Liveness score on attempt [i]
aml
aml screening result data object
aml.risk_level_summary
<Not Screened, High, Medium, Low>
aml.currentstatus
<Not Screened, Red Flag>
aml.matches
Detailed AML screening result. Only available when aml.currentstatus is 'Red Flag'.
aml.matches[i].risk_level
Red flag risk level <HIGH, MEDIUM, LOW>
aml.matches[i].resource_id
Returned only when AML screening has matches. Resource ID is used to request and download the AML report for the specific match.
aml.matches[i].score
AML screening score
nextpageKey
Key-value object delivered when there is a next page.
nextpageKey.id
The last inquired submission ID which is needed to call the next page.
nextpageKey.created_at
'created_at' value of the last inquired submission ID which is needed to call the next page.
bank_verification
The result object of the 'Account Occupancy - South Korea' option when it is activated.
bank_verification.result
Result of the 'Account Occupancy' <success ,fail>
bank_verification.type
Type of authentication <occupancy(account verification ), nameCheck(account holder verification)> (Only 'occupancy' is available for now)
bank_verification.bank_code
The 3 digit bank code.
bank_verification.account_number
The account number.
bank_verification.retry_countj
Verification code sending tried count.

Sample Response - Specific submission

{
"Items":[
{
"data":{
"name":"Jhon Smith",
"gender":"male",
"nationality":"USA",
"date_of_birth":"1998-11-12",
"cf1":"test",
"ip_address":"*.*.*.*",
"idcard_issuingCountry":"USA",
"idcard_issueDate":"2016-08-16",
"idType":"government_id",
"identityNumber":"981112-1******"
},
"email":"[email protected]",
"submission_id":"gt7rcxx9l1o*****",
"created_at":"2022-04-07T00:30:35.919Z",
"userid":"test1",
"kyc":{
"result":"rejected",
"comment":[
"Multiple invalid KYC attempts"
],
"commentCode":[
"too_many_retry"
],
"attempts":[
{
"attemptCnt":1,
"livenessScore":91,
"faceSimilarityScore":99,
"verificationParams":{
"fullName":"Jhon Smith",
"idType":"government_id",
"issueDate":"2016-08-15",
"identityNumber":"981112-1******"
},
"verificationResult":"fail",
"retryMsg":[
"Face compare failed: no matching face"
],
"retryCode":[
"face_compare_fail"
]
},
{
"attemptCnt":2,
"livenessScore":98,
"verificationParams":{
"fullName":"Jhon Smith",
"idType":"government_id",
"issueDate":"2016-08-16",
"identityNumber":"981112-1******"
},
"verificationResult":"success",
"retryMsg":[
"Face compare failed: no matching face"
],
"retryCode":[
"face_compare_fail"
]
},
{
"attemptCnt":3,
"faceSimilarityScore":99,
"verificationParams":{
"fullName":"Jhon Smith",
"idType":"government_id",
"issueDate":"2016-08-16",
"identityNumber":"981112-1******"
},
"verificationResult":"success",
"retryMsg":[
"Face compare failed: no matching face"
],
"retryCode":[
"face_compare_fail"
]
}
]
}
}
]
}

Reject Code & Comment

kyc.commentCode
kyc.comment
id_image_invalidImage
ID document not detected. Please take a picture of your ID document.
id_image_invalidId
Invalid ID document. Please resubmit with another ID document.
id_image_error
Fail to upload the ID image. Please resubmit the KYC process.
id_image_badImage
Fail to read the ID image. Please take a clear picture of your ID document.
id_info_dataMismatch
The entered information does not match with your ID document.
id_info_blacklist
According to the policy, we do not accept KYC from {country}.
id_info_notOfAge
We do not accept KYC anyone under {13} years old.
too_many_retry
Multiple invalid KYC attempts
blacklistCountry
According to the policy, we do not accept KYC from {country}.
under_ageLimit
We do not accept KYC anyone under {13} years old.
invalid_acceptedID
Inacceptable ID type. Please resubmit with another ID, check the valid ID on the submission page.
address_image_invalidImage
Invalid proof of address. Proof of address must include your full name and address. ex)utility bill, bank statement, residency certificate, etc.
address_image_error
Fail to upload proof of address image. Please retry.
address_image_badImage
Fail to read the image. Please take a clear picture of your proof of address.
address_info_expiredDocument
Expired proof of address. The proof of address should be issued within 6 months.
address_info_dataMismatch
Entered information does not match with your proof of address.
timeout
KYC rejected due to timeout
other
*Reject comment written by KYC agents.

GET/Submission/Submission ID

Querying for one, specific submission data.
  • URL and x-api-key required
  • Should be requested with Query Params
  • Available for one submission data
  • The response includes KYC personal info, KYC result, AML result, reject comment and code, retry comment and code.

Request URL

1
curl -X GET "https://rest-api.argoskyc.com/v3/submission?submission_id={submission_id}"\
2
-H "x-api-key: {yourAPIKey}"

Sample Request

1
curl --location --request GET 'https://rest-api.argoskyc.com/v3/submission?submission_id={submission_id}'\
2
--header 'x-api-key: {yourAPIKey}'

Sample Response

1
{
2
"Items": [
3
{
4
"data": {
5
"first_name": "{first_name}",
6
"last_name": "{last_name}",
7
"name": "{name}",
8
"date_of_birth": "{YYYY-MM-DD}",
9
"cf1": "{cf1}",
10
"ip_address": "{ip_address}",
11
"idcard_issuingCountry": "USA",
12
"idType": "drivers_license"
13
},
14
"email": "{email}",
15
"submission_id": "{submission_id}",
16
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
17
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
18
"kyc_result_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
19
"userid": "{userid}",
20
"reviewer": "system",
21
"kyc": {
22
"result": "rejected",
23
"comment": [
24
"Multiple invalid KYC attempts "
25
],
26
"commentCode": [
27
"too_many_retry"
28
],
29
"attempts": [
30
{
31
"attemptCnt": 1,
32
"step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
33
"ocrResult": "success",
34
"retryMsg": [
35
"Failed to read PDF417 Barcode."
36
],
37
"idBarcodeResult": "fail",
38
"retryCode": [
39
"barcode_protocol_fail"
40
]
41
},
42
{
43
"attemptCnt": 2,
44
"step1Time2nd": "YYYY-MM-DD-HH-MM-SS-ZZZ",
45
"ocrResult": "success",
46
"retryMsg": [
47
"Failed to read PDF417 Barcode."
48
],
49
"idBarcodeResult": "fail",
50
"retryCode": [
51
"barcode_protocol_fail"
52
]
53
},
54
{
55
"attemptCnt": 3,
56
"step1Time3rd": "YYYY-MM-DD-HH-MM-SS-ZZZ",
57
"ocrResult": "success",
58
"retryMsg": [
59
"Failed to read PDF417 Barcode."
60
],
61
"idBarcodeResult": "fail",
62
"retryCode": [
63
"barcode_protocol_fail"
64
]
65
}
66
]
67
}
68
}
69
]
70
}

GET/Submission/User ID

Querying for a submission data with specific user_id
  • URL and x-api-key required
  • Should be requested with Query Params
  • It will return submission data which has the same user_id
  • The response includes KYC personal info, KYC result, AML result, reject comment and code, retry comment and code.

Request URL

1
curl -X GET "https://rest-api.argoskyc.com/v3/submission?userid={userid}"\
2
-H "x-api-key: {yourAPIKey}"

Sample Request

1
curl --location --request GET 'https://rest-api.argoskyc.com/v3/submission?userid={userid}' \
2
--header 'x-api-key: {yourAPIKey}'

Sample Response

1
{
2
"Items": [
3
{
4
"data": {
5
"name": "{name}",
6
"gender": "male",
7
"nationality": "KOR",
8
"date_of_birth": "YYYY-MM-DD"
9
},
10
"email": "{email}",
11
"submission_id": "{submission_id}",
12
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
13
"userid" : "{userid}"
14
"reviewer": "{reviewer}",
15
"kyc": {
16
"result": "rejected",
17
"comment": [
18
"Multiple invalid KYC attempts "
19
],
20
"commentCode": [
21
"too_many_retry"
22
]
23
}
24
},
25
{
26
"data": {
27
"name": "{name}",
28
"gender": "male",
29
"nationality": "BRA",
30
"date_of_birth": "YYYY-MM-DD"
31
},
32
"email": "{email}",
33
"submission_id": "{submission_id}",
34
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
35
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
36
"userid" : "{userid}"
37
"reviewer": "{reviewer}",
38
"kyc": {
39
"result": "rejected",
40
"comment": [
41
"test"
42
],
43
"commentCode": [
44
"other"
45
]
46
}
47
},
48
{
49
"data": {
50
"name": "{name}",
51
"gender": "male",
52
"nationality": "KOR",
53
"date_of_birth": "YYYY-MM-DD"
54
},
55
"email": "{email}",
56
"submission_id": "{submission_id}",
57
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
58
"userid" : "{userid}"
59
"reviewer": "{reviewer}",
60
"kyc": {
61
"result": "rejected",
62
"comment": [
63
"Multiple invalid KYC attempts "
64
],
65
"commentCode": [
66
"too_many_retry"
67
]
68
}
69
}
70
}
71
]
72
}

GET/Submission/Email

Querying for a submission data with specific email address
  • URL and x-api-key required
  • Should be requested with Query Params
  • It will return submission data which has the same email address
  • The response includes KYC personal info, KYC result, AML result, reject comment and code, retry comment and code

Request URL

1
curl -X GET "https://rest-api.argoskyc.com/v3/submission?email={email}"\
2
-H "x-api-key: {yourAPIKey}"

Sample Request

1
curl -X GET "https://rest-api.argoskyc.com/v3/submission?email={email}"\
2
-H "x-api-key: {yourAPIKey}"

Sample Response

1
{
2
"Items": [
3
{
4
"data": {
5
"name": "{name}",
6
"gender": "male",
7
"nationality": "KOR",
8
"date_of_birth": "YYYY-MM-DD"
9
},
10
"email": "{email}",
11
"submission_id": "{submission_id}",
12
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
13
"reviewer": "{reviewer}",
14
"kyc": {
15
"result": "rejected",
16
"comment": [
17
"Multiple invalid KYC attempts "
18
],
19
"commentCode": [
20
"too_many_retry"
21
]
22
}
23
},
24
{
25
"data": {
26
"name": "{name}",
27
"gender": "male",
28
"nationality": "BRA",
29
"date_of_birth": "YYYY-MM-DD"
30
},
31
"email": "{email}",
32
"submission_id": "{submission_id}",
33
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
34
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
35
"reviewer": "{reviewer}",
36
"kyc": {
37
"result": "rejected",
38
"comment": [
39
"test"
40
],
41
"commentCode": [
42
"other"
43
]
44
}
45
},
46
{
47
"data": {
48
"name": "{name}",
49
"gender": "male",
50
"nationality": "KOR",
51
"date_of_birth": "YYYY-MM-DD"
52
},
53
"email": "{email}",
54
"submission_id": "{submission_id}",
55
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
56
"reviewer": "{reviewer}",
57
"kyc": {
58
"result": "rejected",
59
"comment": [
60
"Multiple invalid KYC attempts "
61
],
62
"commentCode": [
63
"too_many_retry"
64
]
65
}
66
}
67
}
68
]
69
}

GET/Submission/List

Querying for entire submission data
  • URL and x-api-key required
  • Should be requested with Query Params
  • It will return the entire submission data
  • The response includes KYC personal info, KYC result, AML result, reject comment and code, retry comment and code

Request URL

1
curl -X GET "https://rest-api.argoskyc.com/v3/submission"\
2
-H "x-api-key: {yourAPIKey}"

Sample Request

1
curl --location --request GET 'https://rest-api.argoskyc.com/v3/submission' \
2
--header 'x-api-key: {yourAPIKey}'

Sample Response

1
"Items": [
2
{
3
"data": {
4
"name": "{name}",
5
"gender": "male",
6
"nationality": "KOR",
7
"date_of_birth": "YYYY-MM-DD"
8
},
9
"email": "{email}",
10
"submission_id": "{submission_id}",
11
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
12
"reviewer": "{reviewer}",
13
"kyc": {
14
"result": "rejected",
15
"comment": [
16
"Multiple invalid KYC attempts "
17
],
18
"commentCode": [
19
"too_many_retry"
20
]
21
}
22
},
23
{
24
"data": {
25
"name": "{name}",
26
"gender": "male",
27
"nationality": "BRA",
28
"date_of_birth": "YYYY-MM-DD"
29
},
30
"email": "{email}",
31
"submission_id": "{submission_id}",
32
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
33
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
34
"reviewer": "{reviewer}",
35
"kyc": {
36
"result": "rejected",
37
"comment": [
38
"test"
39
],
40
"commentCode": [
41
"other"
42
]
43
}
44
},
45
{
46
"data": {
47
"name": "{name}",
48
"gender": "male",
49
"nationality": "KOR",
50
"date_of_birth": "YYYY-MM-DD"
51
},
52
"email": "{email}",
53
"submission_id": "{submission_id}",
54
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
55
"reviewer": "{reviewer}",
56
"kyc": {
57
"result": "rejected",
58
"comment": [
59
"Multiple invalid KYC attempts "
60
],
61
"commentCode": [
62
"too_many_retry"
63
]
64
}
65
}
66
}
67
]

GET/Submission/Applicant ID

Get a list of approved submissions submitted by the same person.
  • If there are multiple submissions from people with the same name, date of birth, nationality, gender, and face, it is judged as duplicate submission, and you can check the duplicate submissions.
  • For a typical applicant that doesn't have duplicate submissions, only a single approved submission is pulled.
  • Since the search is based on applicant_id, applicant_id must be obtained from submission information through GET/Submission API.
  • 'applicant_id' is a combination of name, date of birth, gender, nationality and face image. .
    • Submission data with the same 5 data will have the same 'applicant_id'.
    • 'applicanat_id' is generated randomly if no comparison is found.

Request URL

curl -X GET "https://rest-api.argoskyc.com/v3/submission/applicant?applicant_id={applicant_id}"
-H "x-api-key: {yourAPIKey}"

Input Data

* means required parameters.
Parameter
Description
*applicant_id
Unique identifier for each person

Output Data

Response
Description
submission_id
Unique value of submission confirmed as duplicate submission
email
Email address recorded in submission identified as a duplicate submission

Sample Reuqest

1
curl --location --request GET 'https://rest-api.argoskyc.com/v3/submission/applicant?applicant_id={applicant_id}' \
2
--header 'x-api-key: {yourAPIKey}'

Sample Response

1
[
2
{
3
"submission_id": "{submission_id}",
4
"email": "{email}"
5
},
6
{
7
"submission_id": "{submission_id}",
8
"email": "{email}"
9
},
10
{
11
"submission_id": "{submission_id}",
12
"email": "{email}"
13
}
14
]