This method is for a singular entity; if you are in search of a bulk entity method, please refer to this link.
1. Endpoint
GET/Submission/submissionId
Copy
Ask AI
GET https://rest-api.argosidentity.com/v3/submission
2. Authentication
Include the API key in the x-api-key header:x-api-key
Copy
Ask AI
x-api-key: {yourAPIKey}
3. Request Parameters
The request should be in JSON format. Below is a description of the fields:Unique ID of a specific submission.
4. Request Example
GET/Submission/submissionId
Copy
Ask AI
curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}' \
--header 'x-api-key: {yourAPIKey}'
5. Response
5-1. Success Response
result.json
Copy
Ask AI
{
"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": "{********}",
"typeOfPermit": "{F-1}",
"typeOfPermitGovKor": "{F-1}",
"expiryDateOfStayKor": "YYYY-MM-DD",
"nationalityGovKor": "{American}"
},
"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"
},
"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
},
{
"condition": {
"comparisonOperator": "gte",
"target": "median"
},
"matchResults": {
"idCardCustomMatch": {
"result": true,
"processed": true,
"statement": "25 gte 18"
},
"faceImageBirthDateMatch": {
"result": false,
"processed": true,
"statement": "33 gte 34"
},
"faceImageCustomMatch": {
"result": true,
"processed": true,
"statement": "33 gte 18"
},
"idCardBirthDateMatch": {
"result": false,
"processed": true,
"statement": "25 gte 34"
}
},
"conditionIndex": 1,
"finalResult": false
}
],
"logicalOperators": [
"or"
]
}
]
},
"signals": {
"faceAge": [
{
"ageRange": {
"high": 33,
"median": 29,
"low": 25
},
"source": "selfieImage"
}
],
"cameraProcessInfo": [
{
"processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"type": "idcard-front-capture",
"error": null
},
{
"processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"type": "idcard-back-capture",
"error": null
},
{
"processStartTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"processEndTime": "YYYY-MM-DD-HH-MM-SS-ZZZ",
"type": "id-document-face-active",
"error": null
}
],
"startButtonClickTime": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"updateHistory": {
"updateAdmin": "{admin's email}",
"updateTime": "YYYY-MM-DD-HH-MM-SS-ZZZ"
},
"warning":[
{
"userDataType": "string",
"relatedEngine":"string",
"occurrenceTime":"string"
},
{
"userDataType": "string",
"relatedEngine":"string",
"occurrenceTime":"string"
},
{
"userDataType": "string",
"relatedEngine":"string",
"occurrenceTime":"string"
},
{
"userDataType": "string",
"relatedEngine":"string",
"occurrenceTime":"string"
}
},
"review": {
"birthDate": "YYYY-MM-DD",
"fullName": "DANYA ESTEPHANY PARRA ROSAS",
"gender": "female",
"nationality": "USA"
},
"duplicated_users": ["submission_id_1","submissid_id_2"],
"duplicated_selfie_users": ["submission_id_1","submissid_id_2"],
"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}"
},
"memo": {
"text":"dashboard memo",
"updated_at":"YYYY-MM-DD-HH-MM-SS-ZZZ",
},
"userid": "{userid}",
"project_options": {
"option_aml": true,
"option_addressData": false,
"policy_approvePeriod": 0,
"option_idNumber": true,
"policy_blacklistCountries": [],
"policy_acceptedID": [
"government_id",
"foreign_registrator",
"passport",
"drivers_license",
"vehicle_registration_certificate",
"aadhaar",
"residence_permit",
"pancard",
"visa",
"identification_card"
],
"option_mask_documentNumber": false,
"option_validationGov": false,
"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
}
}
]
}