> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.
# GET/Submission
> This API allows you to retrieve ID Check submission data. You can fetch detailed information for a specific submission or filter and retrieve a list of multiple submissions.
## 1. Endpoint
```text GET/Submission theme={null}
GET https://rest-api.argosidentity.com/v3/submission
```
## 2. Authentication
Include the API key in the x-api-key header:
```text x-api-key theme={null}
x-api-key: {yourAPIKey}
```
## 3. Request Parameters
The request parameters should be sent as URL query parameters. Below are the parameter descriptions:
Unique ID of a specific submission (single submission query)
Retrieve a list of submissions matching the user ID
Retrieve a list of submissions matching the email address
Number of results to return (default: 50)
ID for fetching the next page of results
Date for fetching the next page of results
Start date for filtering results (format: `YYYY-MM-DD`)
End date for filtering results (format: `YYYY-MM-DD`)
Use the `request_type` parameter to selectively retrieve specific types of data. Choose one of the following options:
* `kyc`: Returns KYC-related data and `submission_id`.
* `aml`: Returns AML-related data and `submission_id`.
* `data`: Returns personal information data and `submission_id`.
* `others`: Returns all data items excluding KYC, AML, and personal information.
## 4. Request Examples by Query Type
Retrieve detailed information for a specific submission.
### Request Example
```curl GET/Submission/submission_id theme={null}
curl --location 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}' \
--header 'x-api-key: {yourAPIKey}'
```
### Response Example
```json result-id-document.json theme={null}
{
"Items": [
{
"data": {
"age_group": "{age group}",
"first_name": "{first name}",
"last_name": "{last name}",
"full_name": "{full name}",
"full_name_en": "{full name en}",
"gender": "male",
"nationality": "USA",
"date_of_birth": "YYYY-MM-DD",
"address_city": "{city}",
"address_country": "KOR",
"address_state": "{state}",
"address_street": "{street}",
"address_street2": "{street2}",
"address_zipcode": "{zipcode}",
"ip_address": "{ip_address}",
"idcard_issuingCountry": "USA",
"idcard_issueDate": "YYYY-MM-DD",
"idcard_expireDate": "YYYY-MM-DD",
"idType": "drivers_license",
"documentNumber": "{********}",
"typeOfPermit": "{F-1}",
"typeOfPermitGovKor": "{F-1}",
"expiryDateOfStayKor": "YYYY-MM-DD",
"nationalityGovKor": "{American}",
"cf1": "{cf1}",
"cf2": "{cf2}",
"cf3": "{cf3}"
},
"OCR_raw": {
"rotate": {
"value": "0"
},
"address": {
"value": "John Smith, 123 Elm Street, town, CA 91234, USA",
"score": 96,
"accepted": true,
"coordinates": {}
}
},
"ocr": {
"birthDate": "YYYY-MM-DD",
"expireDate": "YYYY-MM-DD",
"issueDate": "YYYY-MM-DD",
"firstName": "{first name}",
"lastName": "{last name}",
"fullName": "{full name}",
"identityNumber": "{identity number}",
"nationality": "USA"
},
"review": {
"birthDate": "YYYY-MM-DD",
"fullName": "{full name}",
"gender": "female",
"nationality": "USA",
"issueDate": "YYYY-MM-DD",
"expireDate": "YYYY-MM-DD",
"documentNumber": "{document number}",
"identityNumber": "{identity number}"
},
"image": {
"idImage": "{idImage from ArgosServer}",
"idBackImage": "{idBackImage from ArgosServer}",
"selfieImage": "{selfieImage from ArgosServer}",
"addressImage": "{addressImage from ArgosServer}"
},
"memo": {
"text": "dashboard memo",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"duplicated_users": ["submission_id_1", "submission_id_2"],
"duplicated_selfie_users": ["submission_id_1", "submission_id_2"],
"email": "{email}",
"submission_id": "{submission_id}",
"recognition_score": "{recognition_score}",
"argos_score": "{argos_score}",
"duplicated_information": "{duplicated_information}",
"custom_duplicated_information": "{custom_duplication_information}",
"applicant_id": "{applicant_id}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc_result_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"userid": "{userid}",
"reviewer": "system",
"project_options": {
"option_aml": true,
"option_addressData": false,
"policy_approvePeriod": 0,
"option_idNumber": true,
"policy_blacklistCountries": [],
"policy_acceptedID": ["government_id", "passport", "drivers_license"],
"option_mask_documentNumber": false,
"option_validationGov": false,
"option_mask_idNumber": false,
"option_documentNumber": true,
"webhookURL": "{webhook_url}",
"policy_ageLimit": 18,
"option_ai_only": false
},
"additional_list": [
{
"answer": "{field_name}",
"inputValue": "{user_input}",
"blockType": "text"
}
],
"kyc": {
"result": "approved",
"comment": [],
"commentCode": [],
"attempts": [
{
"attemptCnt": 1,
"step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"ocrResult": "success",
"verificationResult": "success",
"verification": {
"result": {
"code": "CF-00000",
"message": "Success",
"transactionId": "{transaction_id}",
"extraMessage": ""
},
"data": {
"resAuthenticity": "{authenticity}",
"resExpirationDate": "YYYY-MM-DD",
"resNationality": "{nationality}",
"resAuthenticityDesc": "",
"resStatus": "{status}"
},
"userName": "{fullname}"
},
"verificationParams": {
"idType": "passport",
"nationality": "USA",
"birthDate": "YYYY-MM-DD",
"documentNumber": "{document_number}"
},
"faceSimilarityScore": 84,
"selfieImage": "{selfieImage URL}",
"livenessScore": 76,
"liveness": {
"score": 1.1610267,
"probability": 0.76151925,
"quality": 0.5903906
},
"step2Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ"
}
],
"retry": []
},
"aml": {
"raw_data": {},
"matches": [],
"risk_level_summary": "Not Screened",
"currentstatus": "Not Screened"
},
"verification": {
"faceAge": []
},
"signals": {
"faceAge": [],
"cameraProcessInfo": [
{
"processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"type": "idcard-front-capture",
"error": null
}
],
"startButtonClickTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"confidence": {
"finalData": {
"fullName": 0.9189999999999999,
"gender": 1,
"nationality": 0.9969999999999999,
"birthDate": 1,
"expireDate": 0.9969999999999999,
"documentNumber": 0.9969999999999999
},
"ocrData": {
"gender": 1,
"birthDate": 1,
"documentNumber": 0.99,
"expireDate": 0.99,
"nationality": 0.99,
"fullName": 0.73
},
"ocrExtractedData": {
"birth_date": 1,
"emergency_name": 0.14,
"number": 0.99,
"height": 0.96,
"restrictions": 0.64,
"weight": 1,
"emergency_address": 0.5,
"nationality": 0.99,
"authority": 0.98,
"name": 0.73,
"gender": 1,
"audit_number": 0.98,
"emergency_telephone": 0.9,
"eyes": 0.98,
"donor": 0.17,
"blood_type": 0,
"first_name": 0.73,
"address": 0.88,
"expiry_date": 0.99,
"last_name": 0.98,
"middle_name": 0.73,
"endorsements": 0.98
}
}
},
"updateHistory": {
"updateAdmin": "{admin's email}",
"updateTime": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"warning": [],
"Injection_action": [],
"id_LivenessScore": {},
"projection": {
"projectionId": "{projection_id}",
"projectionName": "{projection_name}"
},
"tokenId": "{token_id}",
"pre_verification": {
"request_id": "{request_id}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"ip_address": "XXX.xx.xx.x",
"fraud_score": 84,
"attempts_frequency": "FirstSeen",
"country_code": "KOR",
"connection_type": "Mobile",
"is_valid": true
}
}
]
}
```
```json result-knowledge-based.json theme={null}
{
"Items": [
{
"data": {
"age_group": "N/A",
"name": "{name}",
"gender": "male",
"nationality": "KOR",
"date_of_birth": "YYYY-MM-DD",
"address_formatted": "{formatted address}",
"address_detail": "{detail address}",
"ssnNumber": "{***-**-****}",
"phoneNumber": "{phone number}",
"cf1": "{cf1}",
"cf2": "{cf2}",
"cf3": "{cf3}"
},
"memo": {
"text": "dashboard memo",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"duplicated_users": ["submission_id_1", "submission_id_2"],
"duplicated_selfie_users": ["submission_id_1", "submission_id_2"],
"email": "{email}",
"submission_id": "{submission_id}",
"duplicated_information": "{duplicated_information}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc_result_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"userid": "{userid}",
"reviewer": "system",
"additional_list": [
{
"answer": "{field_name}",
"inputValue": "{user_input}",
"blockType": "text"
}
],
"aml": {
"raw_data": {},
"matches": [],
"risk_level_summary": "Not Screened",
"currentstatus": "Not Screened"
},
"verification": {
"faceAge": []
},
"signals": {
"faceAge": [],
"cameraProcessInfo": [
{
"processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"type": "knowledge-face-passive",
"error": null
}
],
"startButtonClickTime": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"kyc": {
"result": "approved",
"comment": [],
"commentCode": [],
"attempts": [
{
"attemptCnt": 1,
"step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"step2Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"faceSimilarityScore": 85,
"selfieImage": "{selfieImage URL}",
"livenessScore": 99,
"liveness": {
"score": 1.2,
"probability": 0.8,
"quality": 0.6
},
"detectFace": [
{
"AgeRange": {
"High": 33,
"Low": 25
},
"Gender": {
"Confidence": 99.27,
"Value": "Male"
}
}
]
}
],
"retry": []
},
"projection": {
"projectionId": "{projection_id}",
"projectionName": "{projection_name}"
},
"pre_verification": {
"request_id": "{request_id}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"ip_address": "XXX.xx.xx.x",
"fraud_score": 84,
"attempts_frequency": "FirstSeen",
"country_code": "KOR",
"connection_type": "Mobile",
"is_valid": true
}
}
]
}
```
For detailed response field definitions, refer to the [Response Fields page](/en/idcheck/api-reference/api-reference-guide/get-submission-response-fields).
Retrieve all submissions associated with a specific user ID.
### Request Example
```curl GET/Submission/userid theme={null}
curl --location 'https://rest-api.argosidentity.com/v3/submission?userid={userid}' \
--header 'x-api-key: {yourAPIKey}'
```
### Response Example
```json result.json theme={null}
{
"Items": [
{
"data": {
"name": "{name}",
"gender": "male",
"nationality": "KOR",
"date_of_birth": "YYYY-MM-DD",
"address_formatted": "{formatted address}",
"address_detail": "{detail address}",
"ssnNumber": "{***-**-****}",
"phoneNumber": "{phone number}",
"cf1": "{cf1}",
"cf2": "{cf2}",
"cf3": "{cf3}"
},
"email": "{email}",
"submission_id": "{submission_id}",
"userid": "{userid}",
"duplicated_information": "{duplicated_information}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc_result_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"reviewer": "system",
"recognition_score": "{recognition_score}",
"argos_score": "{argos_score}",
"image": {
"idImage": "{idImage from ArgosServer}",
"idBackImage": "{idBackImage from ArgosServer}",
"selfieImage": "{selfieImage from ArgosServer}",
"addressImage": "{addressImage from ArgosServer}"
},
"memo": {
"text": "dashboard memo",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"kyc": {
"result": "approved",
"comment": [],
"commentCode": [],
"attempts": [
{
"attemptCnt": 1,
"step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"step2Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"faceSimilarityScore": 85,
"selfieImage": "{selfieImage URL}",
"livenessScore": 99,
"liveness": {
"score": 1.2,
"probability": 0.8,
"quality": 0.6
}
}
],
"retry": []
},
"aml": {
"raw_data": {},
"matches": [],
"risk_level_summary": "Not Screened",
"currentstatus": "Not Screened"
},
"additional_list": [
{
"answer": "{field_name}",
"inputValue": "{user_input}",
"blockType": "text"
}
],
"projection": {
"projectionId": "{projection_id}",
"projectionName": "{projection_name}"
}
},
{
"data": {
"name": "{name}",
"gender": "female",
"nationality": "BRA",
"date_of_birth": "YYYY-MM-DD"
},
"email": "{email}",
"submission_id": "{submission_id_2}",
"userid": "{userid}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc": {
"result": "rejected",
"comment": ["Multiple invalid KYC attempts"],
"commentCode": ["too_many_retry"]
}
}
]
}
```
For detailed response field definitions, refer to the [Response Fields page](/en/idcheck/api-reference/api-reference-guide/get-submission-response-fields).
Retrieve all submissions associated with a specific email address.
### Request Example
```curl GET/Submission/email theme={null}
curl --location 'https://rest-api.argosidentity.com/v3/submission?email={email}' \
--header 'x-api-key: {yourAPIKey}'
```
### Response Example
```json result.json theme={null}
{
"Items": [
{
"data": {
"name": "{name}",
"gender": "male",
"nationality": "KOR",
"date_of_birth": "YYYY-MM-DD",
"address_formatted": "{formatted address}",
"address_detail": "{detail address}",
"ssnNumber": "{***-**-****}",
"phoneNumber": "{phone number}",
"cf1": "{cf1}",
"cf2": "{cf2}",
"cf3": "{cf3}"
},
"email": "{email}",
"submission_id": "{submission_id}",
"duplicated_information": "{duplicated_information}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc_result_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"reviewer": "system",
"recognition_score": "{recognition_score}",
"argos_score": "{argos_score}",
"image": {
"idImage": "{idImage from ArgosServer}",
"idBackImage": "{idBackImage from ArgosServer}",
"selfieImage": "{selfieImage from ArgosServer}",
"addressImage": "{addressImage from ArgosServer}"
},
"memo": {
"text": "dashboard memo",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"kyc": {
"result": "approved",
"comment": [],
"commentCode": [],
"attempts": [
{
"attemptCnt": 1,
"step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"step2Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"faceSimilarityScore": 85,
"selfieImage": "{selfieImage URL}",
"livenessScore": 99,
"liveness": {
"score": 1.2,
"probability": 0.8,
"quality": 0.6
}
}
],
"retry": []
},
"aml": {
"raw_data": {},
"matches": [],
"risk_level_summary": "Not Screened",
"currentstatus": "Not Screened"
},
"additional_list": [
{
"answer": "{field_name}",
"inputValue": "{user_input}",
"blockType": "text"
}
],
"projection": {
"projectionId": "{projection_id}",
"projectionName": "{projection_name}"
}
},
{
"data": {
"name": "{name}",
"gender": "female",
"nationality": "BRA",
"date_of_birth": "YYYY-MM-DD"
},
"email": "{email}",
"submission_id": "{submission_id_2}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc": {
"result": "rejected",
"comment": ["Multiple invalid KYC attempts"],
"commentCode": ["too_many_retry"]
}
}
]
}
```
For detailed response field definitions, refer to the [Response Fields page](/en/idcheck/api-reference/api-reference-guide/get-submission-response-fields).
Retrieve all submissions. Pagination is recommended.
### Request Example
```curl GET/Submission/list theme={null}
curl --location 'https://rest-api.argosidentity.com/v3/submission?count=50' \
--header 'x-api-key: {yourAPIKey}'
```
### Response Example
```json result.json theme={null}
{
"Items": [
{
"data": {
"name": "{name}",
"gender": "male",
"nationality": "KOR",
"date_of_birth": "YYYY-MM-DD",
"address_formatted": "{formatted address}",
"address_detail": "{detail address}",
"ssnNumber": "{***-**-****}",
"phoneNumber": "{phone number}",
"cf1": "{cf1}",
"cf2": "{cf2}",
"cf3": "{cf3}"
},
"email": "{email}",
"submission_id": "{submission_id}",
"duplicated_information": "{duplicated_information}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"kyc_result_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"userid": "{userid}",
"reviewer": "system",
"recognition_score": "{recognition_score}",
"argos_score": "{argos_score}",
"image": {
"idImage": "{idImage from ArgosServer}",
"idBackImage": "{idBackImage from ArgosServer}",
"selfieImage": "{selfieImage from ArgosServer}",
"addressImage": "{addressImage from ArgosServer}"
},
"memo": {
"text": "dashboard memo",
"updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"kyc": {
"result": "approved",
"comment": [],
"commentCode": [],
"attempts": [
{
"attemptCnt": 1,
"step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"step2Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"faceSimilarityScore": 85,
"selfieImage": "{selfieImage URL}",
"livenessScore": 99,
"liveness": {
"score": 1.2,
"probability": 0.8,
"quality": 0.6
}
}
],
"retry": []
},
"aml": {
"raw_data": {},
"matches": [],
"risk_level_summary": "Not Screened",
"currentstatus": "Not Screened"
},
"additional_list": [
{
"answer": "{field_name}",
"inputValue": "{user_input}",
"blockType": "text"
}
],
"projection": {
"projectionId": "{projection_id}",
"projectionName": "{projection_name}"
}
},
{
"data": {
"name": "{name}",
"gender": "female",
"nationality": "BRA",
"date_of_birth": "YYYY-MM-DD"
},
"email": "{email}",
"submission_id": "{submission_id_2}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"reviewer": "system",
"recognition_score": "{recognition_score}",
"argos_score": "{argos_score}",
"kyc": {
"result": "rejected",
"comment": ["test"],
"commentCode": ["other"]
}
}
],
"nextpageKey": {
"id": "{submission_id}",
"created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
}
}
```
This API call returns all submissions, which may include a large volume of data. It is recommended to use pagination parameters for optimal performance.
For detailed response field definitions, refer to the [Response Fields page](/en/idcheck/api-reference/api-reference-guide/get-submission-response-fields).
## 5. Secure Data Transfer
The entire data object containing submission\_id should be encrypted and passed as the data query parameter.
Please check the [Query String Encryption](/en/idcheck/getting-started/encrypt-and-decrypt-data/overview#2-query-string-encryption) page for your reference.
### Encrypted Request Example
```curl GET/Submission/encrypted theme={null}
curl --location 'https://rest-api.argosidentity.com/v3/submission?data={encrypted_data}' \
--header 'x-api-key: {yourAPIKey}'
```
When using Secure Data Transfer, the response will be encrypted data, and you should decrypt it to read the data.
### Encryptable Parameters
For projects with Secure Data Transfer enabled, the following parameters can be encrypted:
```json encrypt-available-params.json theme={null}
{
"email": "string",
"start_date": "string",
"end_date": "string",
"submission_id": "string"
}
```
Encrypt the above values using [AES-256-ECB](/en/idcheck/getting-started/encrypt-and-decrypt-data/overview#3-2-api-request-data-encryption-aes-256-ecb) and then URI encode them.
### Encrypted Response
The response includes an isEncrypted flag and encrypted data:
```json result.json theme={null}
{
"data": "encrypted-string",
"isEncrypted": true
}
```
## 6. Response Field Definitions
For detailed definitions of all fields included in GET/Submission API responses, refer to the following page:
Detailed definitions and descriptions of GET/Submission API response fields
## 7. Error Codes
| Error Code | Message | Description |
| ------------------- | -------------------------------- | ------------------------------------------------------- |
| `invalid_payload` | Invalid payload | Unable to parse request body |
| `missing_data` | Required input data is missing | Required fields are missing |
| `invalid_project` | Invalid project | Project ID is invalid |
| `invalid_admin` | Invalid admin | Admin account does not have permission for this project |
| `invalid_parameter` | invalid parameter: `{parameter}` | Unexpected parameter submitted |
| `invalid_format` | invalid format: `${parameter}` | Parameter does not match expected format |
| `processing_error` | Failed to complete migration | Unknown error occurred during processing |