GET/Submission (Bulk as list)

This method is for a bulk entity; if you are in search of a singular entity method, please refer to this link.

1. Endpoint

GET/Submission

GET https://rest-api.argosidentity.com/v3/submission

2. Authentication

Include the API key in the x-api-key header:

x-api-key

x-api-key: {yourAPIKey}

3. Request parameters

The request parameters should be sent as URL query parameters. Below are the parameter descriptions:

submission_id

string

Unique ID of a specific submission.

userid

string

Retrieve a list of submissions matching the user ID.

string

Retrieve a list of submissions matching the email address.

count

string

Number of results to return (default: 50).

nextpage_id

string

ID for fetching the next page of results.

nextpage_date

string

Date for fetching the next page of results.

start_date

string

Start date for filtering results (format: YYYY-MM-DD).

end_date

string

End date for filtering results (format: YYYY-MM-DD).

request_type

string

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 Example

POST/Submission

curl --location 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}' \
--header 'x-api-key: {yourAPIKey}'

5. Response

5-1. Success Response

{
    "Items": [
        {
            "data": {
                "age_group": "{age group}",
                "first_name": "{first name}",
                "last_name": "{last name}",
                "full_name": "{full name}",
                "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",
                "idType": "drivers_license",
                "documentNumber": "{********}"
            },
            "OCR_raw": {
                "rotate": {
                    "value": "0"
                },
                "address": {
                    "value": "John Smith, 123 Elm Street, town, CA 91234, USA",
                    "score": 96,
                    "accepted": true,
                    "coordinates": {coordinates_object}
                    }
                }...
            },
            "ocr": {
                "birthDate": "YYYY-MM-DD",
                "expireDate": "YYYY-MM-DD",
                "firstName": "{first name}","fullName": "{full name}",
                "identityNumber": "{identity number}",
                "lastName": "{last name}",
                "nationality": "USA"
                },
            "duplicated_users": ["submission_id_1","submissid_id_2"],
            "duplicated_selfie_users": ["submission_id_1","submissid_id_2"],
            "review": {
                "birthDate": "YYYY-MM-DD",
                "fullName": "DANYA ESTEPHANY PARRA ROSAS",
                "gender": "female",
                "nationality": "USA"
                },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "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}"
                },
            "verification": {
                "faceAge": [
                    {
                        "usedValues": {
                            "originalSelfieLow": 24, 
                            "originalSelfieHigh": 30,
                            "idMedian": 25, 
                            "birthDateAge": 34,
                            "idHigh": 36,
                            "selfieMedian": 33,
                            "originalSelfieMedian": 27,
                            "idLow": 15, 
                            "originalIdMedian": 19,
                            "selfieLow": 23,
                            "originalIdLow": 16,
                            "selfieHigh": 44,
                            "originalIdHigh": 22
                        },
                        "conditionResults": [
                            {
                                "condition": {
                                    "comparisonOperator": "gte",
                                    "target": "high"
                                },
                                "matchResults": {
                                    "idCardCustomMatch": {
                                        "result": true,
                                        "processed": true,
                                        "statement": "36 gte 18"
                                    },
                                "faceImageBirthDateMatch": {
                                    "result": true,
                                    "processed": true,
                                    "statement": "44 gte 34"
                                },
                                "faceImageCustomMatch": {
                                    "result": true,
                                    "processed": true,
                                    "statement": "44 gte 18"
                                },
                                "idCardBirthDateMatch": {
                                    "result": true,
                                    "processed": true,
                                    "statement": "36 gte 34"
                                }
                            },
                            "conditionIndex": 0,
                            "finalResult": true
                        }
                        ],
                        "logicalOperators": [
                            "or"
                        ]
                    }
                    ]
                },
            "signals": {
                "faceAge": [
                    {
                        "ageRange": {
                            "high": 30,
                            "median": 27,
                            "low": 24
                        },
                        "source": "selfieImage"
                    },
                    {
                        "ageRange": {
                            "high": 22,
                            "median": 19,
                            "low": 16
                        },
                        "source": "idImage"
                    }
                ]
            },
            "memo": {
                "text":"dashboard memo",
	            "updated_at":"YYYY-MM-DD-HH-MM-SS-ZZZ",
                },
            "duplicated_information": "{duplicated_information}",
            "custom_duplicated_information": "{custom_duplication_information}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "Injection_action": [
                {
                    "attemptStatus": "success",
                    "createTime": "{create_time}",
                    "userInput": {
                        "ipAddress": "{ip_address}",
                        "address": {
                            "globalCode": "{global_code}",
                            "compoundCode": "{compound_code}",
                            "formatted_address": "{formatted_address}"
                        }
                    },
                    "option": {
                        "distanceChecks": [
                            {
                                "maxDistanceKm": 200,
                                "source": "ipGeo"
                            }
                        ],
                        "ipRisk": {
                            "durationHour": 8,
                            "failCategory": [
                                "vpn",
                                "proxy",
                                "tor"
                            ]
                        }
                    },
                    "ipVerification": {
                        "requestId": "{request_id}",
                        "status": "success",
                        "ip": "{ip_address}"
                    }
                }
            ],
            "aml": {
                "raw_data": {...},
                "matches": [...],
                "risk_level_summary": "HIGH",
                "currentstatus": "Red Flag"
            },
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts"
                ],
                "commentCode": [
                    "too_many_retry"
                ],
                "attempts": [
                    {
                        "attemptCnt": 1,
                        "step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "ocrResult": "success",
                        "retryMsg": [
                            "Failed to read PDF417 Barcode."
                        ],
                        "idBarcodeResult": "fail",
                        "retryCode": [
                            "barcode_protocol_fail"
                        ]
                    },
                    {
                        "attemptCnt": 2,
                        "liveness": {
                            "score": 1.1610267,
                            "probability": 0.76151925,
                            "quality": 0.5903906
                        },
                        "faceSimilarityScore": 84,
                        "retryMsg": [
                            "The face doesn’t match. Please retry with another face image."
                        ],
                        "selfieImage": "{selfieImage URL}",
                        "livenessScore": 76,
                        "step2Time2nd": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "retryCode": [
                            "face_compare_underscore"
                        ]
                    },
                    {
                        "attemptCnt": 3,
                        "liveness": {
                            "error": "Failed to detect face",
                            "error_code": "FACE_NOT_FOUND"
                        },
                        "retryMsg": [
                            "Liveness fail: Failed to detect face."
                        ],
                        "selfieImage": "{selfieImage URL}",
                        "step2Time3rd": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "retryCode": [
                            "liveness_error"
                        ]
                    }
                ],
                "retry": [
                    {
                        "type": "step1",
                        "retryCnt": 1,
                        "retryCode": "barcode_protocol_fail",
                        "retryMessage": "Failed to read PDF417 Barcode."
                    },
                    {
                        "type": "step2",
                        "retryCnt": 2,
                        "retryCode": "face_compare_underscore",
                        "retryMessage": "The face doesn't match. Please retry with another face image."
                    },
                    {
                        "type": "step2",
                        "retryCnt": 3,
                        "retryCode": "liveness_error",
                        "retryMessage": "Liveness fail: Failed to detect face."
                    }
                ]
            },
            "pre_verification":{
                "request_id":"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 
            }            
        }
    ]
}

5-2-a. Response Field (ID Document)

Field Name	Description	Data Type	Category
`data`	KYC applicant data	Object	KYC Applicant Info
`data.age_group`	age group of the applicant: minor, early-teen, teen, adult	String	KYC Applicant Info
`data.first_name`	First name of the applicant	String	KYC Applicant Info
`data.last_name`	Last name of the applicant	String	KYC Applicant Info
`data.full_name`	Full name of the applicant	String	KYC Applicant Info
`data.gender`	Gender of the applicant (`male` or `female`)	Enum	KYC Applicant Info
`data.nationality`	Country code in ISO alpha-3 format	String	KYC Applicant Info
`data.date_of_birth`	Date of birth in `YYYY-MM-DD` format	Date	KYC Applicant Info
`data.ip_address`	IPv4 format IP address	String	KYC Applicant Info
`data.idType`	Type of ID used	Enum	KYC Applicant Info
`data.idcard_issuingCountry`	ISO alpha-3 format code of the ID issuing country ISO Alpha-3 Country Codes	String	KYC Applicant Info
`data.idcard_issueDate`	ID issuance date in `YYYY-MM-DD` format	String	KYC Applicant Info
`data.idcard_expireDate`	ID expiration date in `YYYY-MM-DD` format	String	KYC Applicant Info
`data.identityNumber`	Identification number	String	KYC Applicant Info
`data.documentNumber`	Document number of the ID	String	KYC Applicant Info
`data.address_city`	City	String	KYC Applicant Info
`data.address_country`	Country	String	KYC Applicant Info
`data.address_state`	State	String	KYC Applicant Info
`data.address_street`	Street	String	KYC Applicant Info
`data.address_zipcode`	Zip code	String	KYC Applicant Info
`data.address_globalCode`	Global address code (e.g., 8Q98HXPG+MP)	String	KYC Applicant Info
`data.address_compoundCode`	Compound address code (e.g., HXPG+MP Seoul, South Korea)	String	KYC Applicant Info
`data.address_formatted`	Converted detailed address	String	KYC Applicant Info
`data.address_input`	User-inputted address	String	KYC Applicant Info
`data.address_detail`	Detailed user-inputted address	String	KYC Applicant Info
`data.cf1`	Custom field 1 optionally added during submission	String	KYC Applicant Info
`data.cf2`	Custom field 2 optionally added during submission	String	KYC Applicant Info
`data.cf3`	Custom field 3 optionally added during submission	String	KYC Applicant Info
`image`	Image object that contains image links for ID Document and selfie from ArgosServer; note that image can be only downloaded only using GET/Image	Object	Submission Info
`image.idImage`	Image link for ID Document from ArgosServer; note that image cannot be downloaded	String	Submission Info
`image.idBackImage`	Image link for Back side of ID Document from ArgosServer; note that image cannot be downloaded	String	Submission Info
`image.selfieImage`	Image link for selfie from ArgosServer; note that image cannot be downloaded	String	Submission Info
`image.addressImage	Image link for Address document image from ArgosServer; note that image cannot be downloaded	String	Submission Info
`memo`	Dashboard’s submission memo’s object	Object	Dashboard Info
`memo.text`	Dashboard’s submission memo’s Content	string	Dashboard Info
`memo.updated_at`	Dashboard’s submission memo’s updated time	string	Dashboard Info
`duplicated_users`	list of sumbissionids that found to have duplicated PII	Array	KYC Applicant Info
`duplicated_selfie_users`	list of sumbissionids that found to have duplicated faces	Array	KYC Applicant Info
`OCR_raw.rotate.value`	The degree value of recognized from OCR	String	KYC Applicant Info
`OCR_raw.{item}.value`	The recognized item’s value of OCR	String	KYC Applicant Info
`OCR_raw.{item}.score`	Score as the recognition ratio (0~100)	Int	KYC Applicant Info
`OCR_raw.{item}.accepted`	Recognition success flag	Bool	KYC Applicant Info
`OCR_raw.{item}.coordinates`	Vector coordinates data	Object	KYC Applicant Info
`ocr.birthDate`	Date of birth recognitzed by OCR (YYYY-MM-DD format)	Date	KYC Applicant Info
`ocr.issueDate`	Issue Date recognized by OCR	Date	KYC Applicant Info
`ocr.expireDate`	Expired Date recognized by OCR	Date	KYC Applicant Info
`ocr.firstName`	First Name recognized by OCR	String	KYC Applicant Info
`ocr.lastName`	Last Name recognized by OCR	String	KYC Applicant Info
`ocr.fullName`	Full Name recognized by OCR	String	KYC Applicant Info
`ocr.gender`	Gender recognized by OCR ( `male` / `female` )	Enum	KYC Applicant Info
`ocr.number`	Document Number recognized by OCR	String	KYC Applicant Info
`ocr.licenseNumber`	License number recognized by OCR	String	KYC Applicant Info
`ocr.identityNumber`	Korean Unique identity number recognized by OCR	String	KYC Applicant Info
`ocr.curpNumber`	Curp Number from Mex.id recognized by OCR	String	KYC Applicant Info
`ocr.nationality`	ISO alpha-3 format nationality code recognized by OCR	String	KYC Applicant Info
`ocr.serialNumber`	Serial number recognized by OCR	String	KYC Applicant Info
`review.birthDate`	Birthdate reviewed by applicant (YYYY-MM-DD format)	Date	KYC Applicant Info
`review.issueDate`	Issue date reviewed by applicant	Date	KYC Applicant Info
`review.expireDate`	Expiration date reviewed by applicant	Date	KYC Applicant Info
`review.fullName`	Full Name reviewed by applicant	String	KYC Applicant Info
`review.gender`	Gender of applicant ( `male` / `female` )	Enum	KYC Applicant Info
`review.nationality`	ISO alpha-3 format nationality code reviewed by applicant	String	KYC Applicant Info
`review.documentNumber`	Document number reviewed by applicant	String	KYC Applicant Info
`review.licenseNumber`	License number reviewed by applicant	String	KYC Applicant Info
`review.identityNumber`	Korean Unique identity number reviewed by applicant	String	KYC Applicant Info
`review.curpNumber`	Curp Number from Mex.id reviewed by applicant	String	KYC Applicant Info
`email`	Email address associated with the submission	String	KYC Applicant Info
`reviewer`	Reviewer Type `system` indicates AI system review, `agent` indicates human review	Enum	KYC Review Info
`Injection_action.attemptStatus`	The status of the injection action result	String	KYC injection Info
`Injection_action.createTime`	Date and time of injection (UTC+0) *order: newest first	String	KYC injection Info
`Injection_action.userInput.address`	Address infomation from user input	Object	KYC injection Info
`Injection_action.option.distanceChecks`	The service’s distance measurement and the length of the distance	Object	KYC injection Info
`Injection_action.option.ipRisk`	IP risk assessment category and prohibition time details	Object	KYC injection Info
`Injection_action.option.ipVerification`	Verified accessed IP information	Object	KYC injection Info
`submission_id`	Unique identifier assigned to each submission	String	Submission Info
`recognition_score`	ID document recognition score	Float	Submission Info
`argos_score`	ARGOS system comprehensive evaluation score	Float	Submission Info
`duplicated_information`	A unique ID is generated based on name, date of birth, gender, and nationality for duplicate checks. (*Always generated when all four criteria are provided.)	String	Submission Info
`applicant_id`	Identifier for users with duplicate submissions	String	Submission Info
`created_at`	Date and time of submission (UTC+0)	String	Submission Info
`kyc_result_at`	Date and time when the KYC result was finalized	String	Submission Info
`updated_at`	Date and time when the submission was last updated	String	Submission Info
`pending_at`	Date and time when the KYC submission was marked pending	String	Submission Info
`userid`	Optional parameter added when creating a submission	String	Submission Info
`additional_list`	User-inputted data for additional forms configured in the dashboard	Array	Additional Form Info
`additional_list.answer`	Name of each additional form field	String	Additional Form Info
`additional_list.inputValue`	User-inputted value for each field	String	Additional Form Info
`additional_list.blockType`	Data type for each additional form field	String	Additional Form Info
`kyc`	Object containing KYC results KYC Status	Object	KYC Result Info
`kyc.result`	Status of the KYC process	Enum	KYC Result Info
`kyc.comment`	Reason for KYC rejection Reject Codes and Comments	String	KYC Result Info
`kyc.commentCode`	Code representing the reason for KYC rejection Reject Codes and Comments	String	KYC Result Info
`kyc.attempts[i].attemptCnt`	Number of retries after failed submissions	Number	KYC Attempt Info
`kyc.attempts[i].idBarcodeResult`	Barcode verification result for IDs from USA, CAN, and MEX	String	KYC Attempt Info
`kyc.attempts[i].verificationResult`	Result of ID verification (`success`, `fail`)	Enum	KYC Attempt Info
`kyc.attempts[i].verification`	Detailed data of ID verification results	Object	KYC Attempt Info
`kyc.attempts[i].verificationParams`	Parameters required for the ID verification execution	Object	KYC Attempt Info
`kyc.attempts[i].errorCode`	Error code generated during liveness, face detection, face comparison, or ID verification	String	KYC Attempt Info
`kyc.attempts[i].errorMsg`	Error message generated during liveness, face detection, face comparison, or ID verification	String	KYC Attempt Info
`kyc.attempts[i].step1Time1st`	Timestamp of the first call to `step1`	String	KYC Attempt Info
`kyc.attempts[i].step1Time2nd`	Timestamp of the second call to `step1`	String	KYC Attempt Info
`kyc.attempts[i].step1Time3rd`	Timestamp of the third call to `step1`	String	KYC Attempt Info
`kyc.attempts[i].step2Time1st`	Timestamp of the first call to `step2`	String	KYC Attempt Info
`kyc.attempts[i].step2Time2nd`	Timestamp of the second call to `step2`	String	KYC Attempt Info
`kyc.attempts[i].step2Time3rd`	Timestamp of the third call to `step2`	String	KYC Attempt Info
`kyc.attempts[i].retryMsg`	Failure reason messages generated during liveness, face detection, face comparison, or ID verification	String	KYC Attempt Info
`kyc.attempts[i].retryCode`	Failure reason codes generated during liveness, face detection, face comparison, or ID verification	String	KYC Attempt Info
`kyc.attempts[i].faceSimilarityScore`	Face comparison similarity score	Float	KYC Attempt Info
`kyc.attempts[i].selfieImage`	URL of the submitted selfie image	String	KYC Attempt Info
`kyc.attempts[i].livenessScore`	Liveness score for the attempt	Float	KYC Attempt Info
`kyc.attempts[i].liveness`	Detailed liveness metrics including `score`, `probability`, and `quality`	Object	KYC Attempt Info
`kyc.attempts[i].liveness.score`	Overall liveness score	Float	KYC Attempt Info
`kyc.attempts[i].liveness.probability`	Probability value for liveness	Float	KYC Attempt Info
`kyc.attempts[i].liveness.quality`	Quality score for liveness	Float	KYC Attempt Info
`verification`	Object containing face-based age verification results	Object	Face Age Verification Info
`verification.faceAge`	Complete results array of face-based age verification (cumulative record per attempt)	Array	Face Age Verification Info
`verification.faceAge[i].usedValues`	Age values used in verification	Object	Face Age Verification Info
`verification.faceAge[i].usedValues.originalSelfieLow`	Lowest age estimate of selfie image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalSelfieHigh`	Highest age estimate of selfie image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalSelfieMedian`	Median age estimate of selfie image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalIdLow`	Lowest age estimate of ID image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalIdHigh`	Highest age estimate of ID image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalIdMedian`	Median age estimate of ID image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.selfieLow`	Lowest age estimate of selfie image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.selfieHigh`	Highest age estimate of selfie image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.selfieMedian`	Median age estimate of selfie image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.idLow`	Lowest age estimate of ID image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.idHigh`	Highest age estimate of ID image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.idMedian`	Median age estimate of ID image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.birthDateAge`	Age calculated from user-input date of birth	Number	Face Age Verification Info
`verification.faceAge[i].conditionResults`	Verification result array for each condition	Array	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].condition`	Condition setting information	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].condition.comparisonOperator`	Comparison operator (`gte`: greater than or equal, `gt`: greater than, `lte`: less than or equal, `lt`: less than)	String	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].condition.target`	Target age type for comparison (`low`, `high`, `median`)	String	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].conditionIndex`	Condition index (starting from 0)	Number	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].finalResult`	Final verification result of the condition (`true`: success, `false`: failure)	Boolean	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults`	Comparison results for each target image and reference age combination	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.idCardCustomMatch`	Comparison result between ID image and custom age value	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.idCardBirthDateMatch`	Comparison result between ID image and birth date age	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.faceImageCustomMatch`	Comparison result between selfie image and custom age value	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.faceImageBirthDateMatch`	Comparison result between selfie image and birth date age	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.*.result`	Success/failure result of individual comparison (`true`: success, `false`: failure, `null`: when absent)	Boolean	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.*.processed`	Whether the comparison was executed (`true`: success, `false`: failure)	Boolean	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.*.statement`	Specific content of comparison operation (e.g., “36 gte 18”)	String	Face Age Verification Info
`verification.faceAge[i].logicalOperators`	Logical operator array between conditions (`and`, `or`)	Array	Face Age Verification Info
`signals`	Object containing raw data extracted from faces	Object	Face Detection Info
`signals.faceAge`	Age range information array extracted from faces (cumulative record per attempt)	Array	Face Detection Info
`signals.faceAge[i].ageRange`	Age range detected in the attempt	Object	Face Detection Info
`signals.faceAge[i].ageRange.low`	Detected lowest age estimate	Number	Face Detection Info
`signals.faceAge[i].ageRange.high`	Detected highest age estimate	Number	Face Detection Info
`signals.faceAge[i].ageRange.median`	Detected median age estimate	Number	Face Detection Info
`signals.faceAge[i].source`	Age estimation source image type (`selfieImage`, `idImage`)	String	Face Detection Info
`kyc.retry`	Array containing retry information that caused retry conditions during KYC processing	Array	KYC Retry Info
`kyc.retry[i].type`	Step type that caused the retry (`step1`, `step2`)	String	KYC Retry Info
`kyc.retry[i].retryCnt`	Retry attempt number for this specific retry condition	Number	KYC Retry Info
`kyc.retry[i].retryCode`	Code identifying the specific retry condition that occurred	String	KYC Retry Info
`kyc.retry[i].retryMessage`	Detailed message explaining the retry condition and recommended action	String	KYC Retry Info
`aml`	Object containing AML screening result data	Object	AML Screening Info
`aml.raw_data`	Object containing raw AML screening results	Object	AML Screening Info
`aml.risk_level_summary`	Summary of the risk level (`Not Screened`, `High`, `Medium`, `Low`)Risk Level	Enum	AML Screening Info
`aml.currentstatus`	Current AML screening status (`Not Screened`, `Red Flag`)AML Screening Status	Enum	AML Screening Info
`aml.matches`	Detailed AML screening results (only available when `aml.currentstatus` is `Red Flag`)AML Screening Info	Array	AML Screening Info
`aml.matches[i].risk_level`	Risk level of the Red Flag (`HIGH`, `MEDIUM`, `LOW`) Risk Level	Enum	AML Screening Info
`aml.matches[i].argos_number`	Unique ID for retrieving the AML report	String	AML Screening Info
`aml.matches[i].resource_id`	Unique resource ID for retrieving the AML report	String	AML Screening Info
`aml.matches[i].score`	AML screening match score	Float	AML Screening Info
`aml.matches[i].risk_icons`	Risk icons for the AML screening	Array	AML Screening Info
`nextpageKey`	Key object provided when additional pages of results are available	Object	Pagination Info
`nextpageKey.id`	ID of the last submission retrieved, required for fetching the next page	String	Pagination Info
`nextpageKey.created_at`	Timestamp of the last submission retrieved, required for fetching the next page	String	Pagination Info
`bank_verification`	Object containing bank account verification results (for Korean users)	Object	Bank Verification Info
`bank_verification.result`	Bank verification result (`success`, `fail`)	Enum	Bank Verification Info
`bank_verification.type`	Type of bank verification (`occupancy` (1 KRW verification), `nameCheck`)	Enum	Bank Verification Info
`bank_verification.bank_code`	Bank code used for verification	String	Bank Verification Info
`bank_verification.account_number`	Account number used for verification	String	Bank Verification Info
`bank_verification.retry_count`	Number of failures during code transmission (pre-step2)	Number	Bank Verification Info
`id_LivenessScore`	Object containing ID Card Liveness Score data	Object	Liveness Score Info
`id_LivenessScore.Screen_play`	Liveness score for the `Screen play` pipeline	Float	Liveness Score Info
`id_LivenessScore.Paper_printed`	Liveness score for the `Paper printed` pipeline	Float	Liveness Score Info
`id_LivenessScore.Replace_portraits`	Liveness score for the `Replace portraits` pipeline	Float	Liveness Score Info
`Injection_action`	Object containing injection process execution history	Object	Injection Process Info
`Injection_action.type`	Type of the injection process	String	Injection Process Info
`Injection_action.time`	Most recent execution time of the specified injection process type	String	Injection Process Info
`projection`	The object contains submission projection data	Object	Projection Info
`projection.projectionId`	The projection ID into applied submission * If the submission created a projection ID, only the ID is shown.	String	Projection Info
`projection.projectionName`	Applied submission projection name * If the submission created a projection name, only the name is shown.	String	Projection Info
`tokenId`	Token ID used for live-form submissions in private mode	String	Submission Info
`pre_verification`	list of pre_verification object	object	pre_verification Info
`pre_verification.request_id`	Request id of pre_verification	String	pre_verification Info
`pre_verification.created_at`	Request Timestamp	String	pre_verification Info
`pre_verification.ip_address`	Request IP address	String	pre_verification Info
`pre_verification.fraud_score`	Fraud score	Number	pre_verification Info
`pre_verification.attempts_frequency`	Frequency of Subnet trials: [0=‘FirstSeen’, 1~~9=‘Rare’, 10~~29=‘Frequent’, 30+=‘VeryFrequent’]	String	pre_verification Info
`pre_verification.country_code`	Country code of requested IP address	String	pre_verification Info
`pre_verification.connection_type`	Connect type: [‘Residential’, ‘Corporate’, ‘Education’, ‘Mobile’, ‘DataCenter’]	String	pre_verification Info
`pre_verification.is_valid`	Status of pre_verification whether it is fail or pass	Boolean	pre_verification Info

5-2-b. Response Field (Knowledge-based)

Field Name	Description	Data Type	Category
`data`	KYC applicant data	Object	KYC Applicant Info
`data.name`	Name of the applicant	String	KYC Applicant Info
`data.gender`	Gender of the applicant (`male` or `female`)	Enum	KYC Applicant Info
`data.nationality`	Country code in ISO alpha-3 format	String	KYC Applicant Info
`data.date_of_birth`	Date of birth in `YYYY-MM-DD` format	Date	KYC Applicant Info
`data.address_formatted`	Converted detailed address	String	KYC Applicant Info
`data.address_detail`	Detailed user-inputted address	String	KYC Applicant Info
`data.ssnNumber`	Social Security Number * for applying the lowerCamelCase convention to the written Number once more.	String	KYC Applicant Info
`data.phoneNumber`	Phone Number	String	KYC Applicant Info
`data.cf1`	Custom field 1 optionally added during submission	String	KYC Applicant Info
`data.cf2`	Custom field 2 optionally added during submission	String	KYC Applicant Info
`data.cf3`	Custom field 3 optionally added during submission	String	KYC Applicant Info
`email`	Email address associated with the submission	String	KYC Applicant Info
`reviewer`	Reviewer Type `system` indicates AI system review, `agent` indicates human review	Enum	KYC Review Info
`submission_id`	Unique identifier assigned to each submission	String	Submission Info
`duplicated_information`	A unique ID is generated based on name, date of birth, gender, and nationality for duplicate checks. (*Always generated when all four criteria are provided.)	String	Submission Info
`created_at`	Date and time of submission (UTC+0)	String	Submission Info
`kyc_result_at`	Date and time when the KYC result was finalized	String	Submission Info
`updated_at`	Date and time when the submission was last updated	String	Submission Info
`pending_at`	Date and time when the KYC submission was marked pending	String	Submission Info
`userid`	Optional parameter added when creating a submission	String	Submission Info
`additional_list`	User-inputted data for additional forms configured in the dashboard	Array	Additional Form Info
`additional_list.answer`	Name of each additional form field	String	Additional Form Info
`additional_list.inputValue`	User-inputted value for each field	String	Additional Form Info
`additional_list.blockType`	Data type for each additional form field	String	Additional Form Info
`kyc`	Object containing KYC results KYC Status	Object	KYC Result Info
`kyc.result`	Status of the KYC process	Enum	KYC Result Info
`kyc.comment`	Reason for KYC rejection Reject Codes and Comments	String	KYC Result Info
`kyc.commentCode`	Code representing the reason for KYC rejection Reject Codes and Comments	String	KYC Result Info
`kyc.attempts[i].attemptCnt`	Number of retries after failed submissions	Number	KYC Attempt Info
`kyc.attempts[i].errorCode`	Error code generated during face recognition and comparison verification	String	KYC Attempt Info
`kyc.attempts[i].errorMsg`	Error message generated during face recognition and comparison verification	String	KYC Attempt Info
`kyc.attempts[i].step1Time1st`	Timestamp of the first call to `step1`	String	KYC Attempt Info
`kyc.attempts[i].step1Time2nd`	Timestamp of the second call to `step1`	String	KYC Attempt Info
`kyc.attempts[i].step1Time3rd`	Timestamp of the third call to `step1`	String	KYC Attempt Info
`kyc.attempts[i].step2Time1st`	Timestamp of the first call to `step2`	String	KYC Attempt Info
`kyc.attempts[i].step2Time2nd`	Timestamp of the second call to `step2`	String	KYC Attempt Info
`kyc.attempts[i].step2Time3rd`	Timestamp of the third call to `step2`	String	KYC Attempt Info
`kyc.attempts[i].retryMsg`	Failure reason messages generated during liveness, face detection, face comparison, or ID verification	String	KYC Attempt Info
`kyc.attempts[i].retryCode`	Failure reason codes generated during liveness, face detection, face comparison, or ID verification	String	KYC Attempt Info
`kyc.attempts[i].faceSimilarityScore`	Face comparison similarity score	Float	KYC Attempt Info
`kyc.attempts[i].selfieImage`	URL of the submitted selfie image	String	KYC Attempt Info
`kyc.attempts[i].livenessScore`	Liveness score for the attempt	Float	KYC Attempt Info
`kyc.attempts[i].liveness`	Detailed liveness metrics including `score`, `probability`, and `quality`	Object	KYC Attempt Info
`kyc.attempts[i].liveness.score`	Overall liveness score	Float	KYC Attempt Info
`kyc.attempts[i].liveness.probability`	Probability value for liveness	Float	KYC Attempt Info
`kyc.attempts[i].liveness.quality`	Quality score for liveness	Float	KYC Attempt Info
`kyc.attempts[i].detectFace`	Array containing face detection results (AWS Rekognition DetectFaces API response)	Array	Face Detection Info
`kyc.attempts[i].detectFace.AgeRange`	Age range information of detected face	Object	Face Detection Info
`kyc.attempts[i].detectFace.AgeRange.High`	Highest estimated age of detected face	Number	Face Detection Info
`kyc.attempts[i].detectFace.AgeRange.Low`	Lowest estimated age of detected face	Number	Face Detection Info
`kyc.attempts[i].detectFace.Gender.Confidence`	Gender detection confidence level (0~100)	Float	Face Detection Info
`kyc.attempts[i].detectFace.Gender.Value`	Detected gender (`Male`, `Female`)	String	Face Detection Info
`verification`	Object containing face-based age verification results	Object	Face Age Verification Info
`verification.faceAge`	Complete results array of face-based age verification (cumulative record per attempt)	Array	Face Age Verification Info
`verification.faceAge[i].usedValues`	Age values used in verification	Object	Face Age Verification Info
`verification.faceAge[i].usedValues.originalSelfieLow`	Lowest age estimate of selfie image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalSelfieHigh`	Highest age estimate of selfie image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalSelfieMedian`	Median age estimate of selfie image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalIdLow`	Lowest age estimate of ID image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalIdHigh`	Highest age estimate of ID image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.originalIdMedian`	Median age estimate of ID image before LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.selfieLow`	Lowest age estimate of selfie image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.selfieHigh`	Highest age estimate of selfie image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.selfieMedian`	Median age estimate of selfie image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.idLow`	Lowest age estimate of ID image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.idHigh`	Highest age estimate of ID image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.idMedian`	Median age estimate of ID image after LOW/HIGH extension settings applied	Number	Face Age Verification Info
`verification.faceAge[i].usedValues.birthDateAge`	Age calculated from user-input date of birth	Number	Face Age Verification Info
`verification.faceAge[i].conditionResults`	Verification result array for each condition	Array	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].condition`	Condition setting information	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].condition.comparisonOperator`	Comparison operator (`gte`: greater than or equal, `gt`: greater than, `lte`: less than or equal, `lt`: less than)	String	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].condition.target`	Target age type for comparison (`low`, `high`, `median`)	String	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].conditionIndex`	Condition index (starting from 0)	Number	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].finalResult`	Final verification result of the condition (`true`: success, `false`: failure)	Boolean	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults`	Comparison results for each target image and reference age combination	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.idCardCustomMatch`	Comparison result between ID image and custom age value	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.idCardBirthDateMatch`	Comparison result between ID image and birth date age	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.faceImageCustomMatch`	Comparison result between selfie image and custom age value	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.faceImageBirthDateMatch`	Comparison result between selfie image and birth date age	Object	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.*.result`	Success/failure result of individual comparison (`true`: success, `false`: failure, `null`: when absent)	Boolean	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.*.processed`	Whether the comparison was executed (`true`: success, `false`: failure)	Boolean	Face Age Verification Info
`verification.faceAge[i].conditionResults[j].matchResults.*.statement`	Specific content of comparison operation (e.g., “36 gte 18”)	String	Face Age Verification Info
`verification.faceAge[i].logicalOperators`	Logical operator array between conditions (`and`, `or`)	Array	Face Age Verification Info
`signals`	Object containing raw data extracted from faces	Object	Face Detection Info
`signals.faceAge`	Age range information array extracted from faces (cumulative record per attempt)	Array	Face Detection Info
`signals.faceAge[i].ageRange`	Age range detected in the attempt	Object	Face Detection Info
`signals.faceAge[i].ageRange.low`	Detected lowest age estimate	Number	Face Detection Info
`signals.faceAge[i].ageRange.high`	Detected highest age estimate	Number	Face Detection Info
`signals.faceAge[i].ageRange.median`	Detected median age estimate	Number	Face Detection Info
`signals.faceAge[i].source`	Age estimation source image type (`selfieImage`, `idImage`)	String	Face Detection Info
`memo`	Dashboard’s submission memo’s object	Object	Dashboard Info
`memo.text`	Dashboard’s submission memo’s Content	string	Dashboard Info
`memo.updated_at`	Dashboard’s submission memo’s updated time	string	Dashboard Info
`duplicated_users`	list of sumbissionids that found to have duplicated PII	Array	KYC Applicant Info
`duplicated_selfie_users`	list of sumbissionids that found to have duplicated faces	Array	KYC Applicant Info
`aml`	Object containing AML screening result data	Object	AML Screening Info
`aml.raw_data`	Object containing raw AML screening results	Object	AML Screening Info
`aml.risk_level_summary`	Summary of the risk level (`Not Screened`, `High`, `Medium`, `Low`)Risk Level	Enum	AML Screening Info
`aml.currentstatus`	Current AML screening status (`Not Screened`, `Red Flag`)AML Screening Status	Enum	AML Screening Info
`aml.matches`	Detailed AML screening results (only available when `aml.currentstatus` is `Red Flag`)AML Screening Info	Array	AML Screening Info
`aml.matches[i].risk_level`	Risk level of the Red Flag (`HIGH`, `MEDIUM`, `LOW`) Risk Level	Enum	AML Screening Info
`aml.matches[i].argos_number`	Unique ID for retrieving the AML report	String	AML Screening Info
`aml.matches[i].resource_id`	Unique resource ID for retrieving the AML report	String	AML Screening Info
`aml.matches[i].score`	AML screening match score	Float	AML Screening Info
`aml.matches[i].risk_icons`	Risk icons for the AML screening	Array	AML Screening Info
`nextpageKey`	Key object provided when additional pages of results are available	Object	Pagination Info
`nextpageKey.id`	ID of the last submission retrieved, required for fetching the next page	String	Pagination Info
`nextpageKey.created_at`	Timestamp of the last submission retrieved, required for fetching the next page	String	Pagination Info
`projection`	The object contains submission projection data	Object	Projection Info
`projection.projectionId`	The projection ID into applied submission * If the submission created a projection ID, only the ID is shown.	String	Projection Info
`projection.projectionName`	Applied submission projection name * If the submission created a projection name, only the name is shown.	String	Projection Info
`tokenId`	Token ID used for live-form submissions in private mode	String	Submission Info
`pre_verification`	list of pre_verification object	object	pre_verification Info
`pre_verification.request_id`	Request id of pre_verification	String	pre_verification Info
`pre_verification.created_at`	Request Timestamp	String	pre_verification Info
`pre_verification.ip_address`	Request IP address	String	pre_verification Info
`pre_verification.fraud_score`	Fraud score	Number	pre_verification Info
`pre_verification.attempts_frequency`	Frequency of Subnet trials: [0=‘FirstSeen’, 1~~9=‘Rare’, 10~~29=‘Frequent’, 30+=‘VeryFrequent’]	String	pre_verification Info
`pre_verification.country_code`	Country code of requested IP address	String	pre_verification Info
`pre_verification.connection_type`	Connect type: [‘Residential’, ‘Corporate’, ‘Education’, ‘Mobile’, ‘DataCenter’]	String	pre_verification Info
`pre_verification.is_valid`	Status of pre_verification whether it is fail or pass	Boolean	pre_verification Info

5-3. Error Codes

Error Code	Message	Description
`invalid_payload`	Invalid payload	Unable to parse the request body.
`missing_data`	Required input data is missing	One or more required fields are missing.
`invalid_project`	Invalid project	The provided project ID is not valid.
`invalid_admin`	Invalid admin	The admin account does not have permission for this project.
`invalid_parameter`	Invalid parameter: `{parameter}`	An unexpected parameter was submitted.
`invalid_format`	Invalid format: `${parameter}`	A parameter does not match the expected format.
`processing_error`	Failed to complete migration	An unknown error occurred during processing.

6. Encryption Options

Pre-requisite: You must enable the secure encryption option. Before applying encryption, please review the guide first.

For enhanced security, the request body can be encrypted. When using encryption:

Encrypt the entire request body object.
Send the encrypted string as the body parameter.

6-1. Encrypted Request Example

{
  "start_date": "2025-01-01",
  "end_date": "2025-03-01"
}

Available options are below.

encrypt-available-params.json

body : encrypt({
		email : 'string',
		start_date : 'string',
		end_date : 'string',
		submission_id: 'string'
	})

Encrypt value with AES-256-ECB and encoded URI.

N34SNtWaavEfgtg1g%2Bo%2B9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw%3D%3D

And request with a query string, the name of which is data, after the endpoint.

curl -X GET "https://rest-api.argosidentity.com/v3/submission?data=N34SNtWaavEfgtg1g%2Bo%2B9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw%3D%3D" \
--header 'Content-Type: application/json' \
--header 'x-api-key: change_your_api_key'

6-2. Encrypted Response

The response will include the isEncrypted flag and encrypted data:

encrypted-response.json

response : {
   body : {
    "data": "encrypted-string",
    "isEncrypted": true
   }
}

Overview

API Reference

Data Structure Guide

GET/Submission (Bulk as list)

1. Endpoint

2. Authentication

3. Request parameters

4. Request Example

5. Response

5-1. Success Response

5-2-a. Response Field (ID Document)

5-2-b. Response Field (Knowledge-based)

5-3. Error Codes

6. Encryption Options

6-1. Encrypted Request Example

6-2. Encrypted Response

Overview

API Reference

Data Structure Guide

​1. Endpoint

​2. Authentication

​3. Request parameters

​4. Request Example

​5. Response

​5-1. Success Response

​5-2-a. Response Field (ID Document)

​5-2-b. Response Field (Knowledge-based)

​5-3. Error Codes

​6. Encryption Options

​6-1. Encrypted Request Example

​6-2. Encrypted Response

1. Endpoint

2. Authentication

3. Request parameters

4. Request Example

5. Response

5-1. Success Response

5-2-a. Response Field (ID Document)

5-2-b. Response Field (Knowledge-based)

5-3. Error Codes

6. Encryption Options

6-1. Encrypted Request Example

6-2. Encrypted Response