GET/Submission
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.

Request URL

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

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.

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.idType
ID card type <passport, government_id, drivers_license>
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

Sample Response - Specific submission

1
{
2
"Items":[
3
{
4
"data":{
5
"name":"Jhon Smith",
6
"gender":"male",
7
"nationality":"USA",
8
"date_of_birth":"1998-11-12",
9
"cf1":"test",
10
"ip_address":"*.*.*.*",
11
"idcard_issuingCountry":"USA",
12
"idcard_issueDate":"2016-08-16",
13
"idType":"government_id",
14
"identityNumber":"981112-1******"
15
},
16
"email":"[email protected]",
17
"submission_id":"gt7rcxx9l1o*****",
18
"created_at":"2022-04-07T00:30:35.919Z",
19
"userid":"test1",
20
"kyc":{
21
"result":"rejected",
22
"comment":[
23
"Multiple invalid KYC attempts"
24
],
25
"commentCode":[
26
"too_many_retry"
27
],
28
"attempts":[
29
{
30
"attemptCnt":1,
31
"livenessScore":91,
32
"faceSimilarityScore":99,
33
"verificationParams":{
34
"fullName":"Jhon Smith",
35
"idType":"government_id",
36
"issueDate":"2016-08-15",
37
"identityNumber":"981112-1******"
38
},
39
"verificationResult":"fail",
40
"retryMsg":[
41
"Face compare failed: no matching face"
42
],
43
"retryCode":[
44
"face_compare_fail"
45
]
46
},
47
{
48
"attemptCnt":2,
49
"livenessScore":98,
50
"verificationParams":{
51
"fullName":"Jhon Smith",
52
"idType":"government_id",
53
"issueDate":"2016-08-16",
54
"identityNumber":"981112-1******"
55
},
56
"verificationResult":"success",
57
"retryMsg":[
58
"Face compare failed: no matching face"
59
],
60
"retryCode":[
61
"face_compare_fail"
62
]
63
},
64
{
65
"attemptCnt":3,
66
"faceSimilarityScore":99,
67
"verificationParams":{
68
"fullName":"Jhon Smith",
69
"idType":"government_id",
70
"issueDate":"2016-08-16",
71
"identityNumber":"981112-1******"
72
},
73
"verificationResult":"success",
74
"retryMsg":[
75
"Face compare failed: no matching face"
76
],
77
"retryCode":[
78
"face_compare_fail"
79
]
80
}
81
]
82
}
83
}
84
]
85
}
Copied!

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/Applicant

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.

Request URL

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

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