POST/Submission/Step 1

Request URL

1
curl -X POST "https://rest-api.argoskyc.com/v3/submission/step1"
2
-H "x-api-key: {yourAPIKey}"
3
-d ...
Copied!

Input Data

* means required parameters.
Parameter
Format
Description
*issuingCountry
ISO alpha 3 format of the country the ID card is issued.
*email
string
email address of the KYC applicant
*idType
string
<passport, government_id, drivers_license>
*idImage
file
jpg, jpeg, png file format of the ID front image
(recommendation: 1mb, limit: 2mb)
idBackImage
file
jpg, jpeg, png file format of the ID back image
(recommendation: 1mb, limit: 2mb)
userid
string
custom optional unique identifier of the user
cf1
string
custom optional field
cf2
string
custom optional field
cf3
string
custom optional field

Sample Request 1

1
curl --location --request POST 'https://rest-api.argoskyc.com/v3/submission/step1' \
2
--header 'x-api-key: {YOUR_API_KEY}' \
3
--form 'issuingCountry="USA"' \
4
--form 'email="[email protected]"' \
5
--form 'idType="drivers_license"' \
6
--form '[email protected]"/C:/Users/sampleID.jpg"' \
7
--form 'cf1="test"' \
8
--form 'userid="user1"'
Copied!

Sample Request 2

1
var myHeaders = new Headers();
2
myHeaders.append("x-api-key", "{YOUR_API_KEY}");
3
4
var formdata = new FormData();
5
formdata.append("issuingCountry", "USA");
6
formdata.append("email", "[email protected]");
7
formdata.append("idType", "drivers_license");
8
formdata.append("idImage", fileInput.files[0], "/C:/Users/sampleID.jpg");
9
formdata.append("cf1", "test");
10
formdata.append("userid", "user1");
11
12
var requestOptions = {
13
method: 'POST',
14
headers: myHeaders,
15
body: formdata,
16
redirect: 'follow'
17
};
18
19
fetch("https://rest-api.argoskyc.com/v3/submission/step1", requestOptions)
20
.then(response => response.text())
21
.then(result => console.log(result))
22
.catch(error => console.log('error', error));
Copied!

Output Data

Response
Description
Submissionid
submission의 ID. *It will be needed at STEP 2*
reviewOCRData
OCR object that contains ID card information. If OCR fails, this parameter is not returned.
reviewOCRData.ocr_birthDate
YYYY-MM-DD format date of birth
reviewOCRData.accepted_ocr_birthDate
Birthdate recognition: true/false
reviewOCRData.ocr_issueDate
Issued date
reviewOCRData.accepted_ocr_issueDate
Issue date recognition: true/false
reviewOCRData.ocr_expireDate
Expiary date
reviewOCRData.accepted_ocr_expireDate
Expiary date recognition: true/false
reviewOCRData.ocr_lastName
Last name
reviewOCRData.accepted_ocr_lastName
Last name recognition: true/false
reviewOCRData.ocr_firstName
First name
reviewOCRData.accepted_ocr_firstName
First name recognition: true/false
reviewOCRData.ocr_name
Full name
reviewOCRData.accepted_ocr_name
Name recognition: true/false
reviewOCRData.ocr_gender
Gender
reviewOCRData.accepted_ocr_gender
Gender recognition: true/false
reviewOCRData.ocr_nationality
ISO3 code format of nationality if available
reviewOCRData.accepted_ocr_nationality
Nationality recognition: true/false
reviewOCRData.ocr_identityNumber
Identity number
reviewOCRData.accepted_ocr_identityNumber
Identity number recognition: true/false

Sample Response

1
{
2
"document_fields": {
3
"gender": false,
4
"expireDate": true,
5
"nationality": false,
6
"documentNumber": true,
7
"issueDate": true,
8
"identityNumber": true
9
},
10
"file_back_upload": true,
11
"idBackImage": "https://liveformimages135940-qqa.s3.ap-northeast-2.amazonaws.com/t5ckpk03m4/cb6f4bbd-4ea4-45c6-8580-5e57f02d8066_drivers_license.png",
12
"missing_fields": [],
13
"reviewOCRData": {
14
"accepted_ocr_issueDate": true,
15
"ocr_issueDate": "YYYY-MM-DD",
16
"accepted_ocr_expireDate": true,
17
"ocr_expireDate": "YYYY-MM-DD",
18
"ocr_gender": "male",
19
"ocr_nationality": "KOR",
20
"accepted_ocr_nationality": true,
21
"ocr_birthDate": "YYYY-MM-DD",
22
"ocr_identityNumber": "9*****-1******",
23
"accepted_ocr_birthDate": true,
24
"accepted_ocr_identityNumber": true,
25
"accepted_ocr_gender": true,
26
"ocr_name": "test"
27
},
28
"file_upload": true,
29
"submissionId": "3pjx8m9l46*****",
30
"idImage": "https://liveformimages135940-qqa.s3.ap-northeast-2.amazonaws.com/t5ckpk03m4/64ba9ea0-80ed-4e71-be54-8ad81977dcc7_drivers_license.png"
31
}
Copied!

Error Codes (400 Errors)

Error Code
Message
Description
invalid_payload
Failed to parse the input data.
It occurs at API calls, mostly when no image file or wrong image file has submitted.
invalid_id_image
Invalid ID image. Please retry with another ID image.
The ID doesn't contain enough information to process KYC.
invalid_request
Failed to find the project. Please check the project ID.
There is no matching project ID. Please check the project ID again.
invalid_project
This project is not available.
When the status of the project if 'closed'. Please contact Help Desk.
missing_parameters
Missing required parameters.
Missing required parameters: issuingCountry, email, idType
invalid_id_type
Invalid id type: Id type must be passport, government_id or drivers_license.
Missing required parameters: government_id, passport, drivers_license
invalid_email
Invalid email address format.
Invalid email address format.
id_image_error
ID image processing error. Please retry.
ID image processing error.
data_processing_error
Data processing error. Please retry.
Data processing error.
save_image_error
ID image save error. Please retry.
ID image save error.
processed_submission
{email} has approved KYC data. No need to submit another KYC.
When the email account aleady has a approved KYC data.
reviewing
{email}’s KYC is currently reviewing. Please wait.
When the email account has a pending submission.
not_an_id
Please take a picture of an ID card.
Invalid ID image(An image of something else other than an ID card)
id_detection_error
ID detection error. Please retry.
An error occurred while detecting ID.