Links

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. Please refer to the Input Data table for detail.

Request URL

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

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)

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_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
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
submission_id
Identifier given to each submission
applicant_id
Identifier given to duplicated applicant
created_at
KYC submitted date and time.
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].error
Liveness, Detect face, Face compare, Authentication(Korean) error message
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].livenessScore
Liveness score on attempt [i]
kyc.attempts[i].faceSimilarityScore
Face similarity score on attempt [i]
kyc.attempts[i].verificationParams
Authentication data on attempt [i]
kyc.attempts[i].verificationResult
Authentication result on on attempt [i] <success, fail>
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].resource_id
Returned only when AML screening has matches. Resource ID is used to request and download the AML report for the specific match.
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.

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

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