1. Endpoint
GET https://rest-api.argosidentity.com/v3/submission
GET https://kr.rest-api.argosidentity.com/v3/submission
2. Autenticación
Incluya la clave API en el encabezado x-api-key:x-api-key
x-api-key: {yourAPIKey}
3. Parámetros de Solicitud
Los parámetros de solicitud deben enviarse como parámetros de consulta URL. A continuación se encuentran las descripciones de los parámetros:string
ID único de un envío específico (consulta de envío individual)
string
Consultar una lista de envíos que coincidan con el ID de usuario
string
Consultar una lista de envíos que coincidan con la dirección de email
string
predeterminado:"50"
Número de resultados a devolver (predeterminado: 50)
string
ID para obtener la siguiente página de resultados
string
Fecha para obtener la siguiente página de resultados
string
Fecha de inicio para filtrar resultados (formato:
YYYY-MM-DD)string
Fecha de fin para filtrar resultados (formato:
YYYY-MM-DD)string
Use el parámetro
request_type para consultar selectivamente tipos específicos de datos. Elija una de las siguientes opciones:kyc: Devuelve datos relacionados con KYC ysubmission_id.aml: Devuelve datos relacionados con AML ysubmission_id.data: Devuelve datos de información personal ysubmission_id.others: Devuelve todos los elementos de datos excluyendo KYC, AML e información personal.
4. Ejemplos de Solicitud por Tipo de Consulta
- Envío Individual (submission_id)
- Por ID de Usuario (userid)
- Por Email (email)
- Listar Todos los Envíos
Consultar información detallada de un envío específico.
Ejemplo de Solicitud
curl --location 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}' \
--header 'x-api-key: {yourAPIKey}'
curl --location 'https://kr.rest-api.argosidentity.com/v3/submission?submission_id={submission_id}' \
--header 'x-api-key: {yourAPIKey}'
Ejemplo de Respuesta
{
"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
}
}
]
}
{
"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
}
}
]
}
Para definiciones detalladas de los campos de respuesta, consulte la página de Campos de Respuesta.
Consultar todos los envíos asociados con un ID de usuario específico.
Ejemplo de Solicitud
curl --location 'https://rest-api.argosidentity.com/v3/submission?userid={userid}' \
--header 'x-api-key: {yourAPIKey}'
curl --location 'https://kr.rest-api.argosidentity.com/v3/submission?userid={userid}' \
--header 'x-api-key: {yourAPIKey}'
Ejemplo de Respuesta
result.json
{
"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"]
}
}
]
}
Para definiciones detalladas de los campos de respuesta, consulte la página de Campos de Respuesta.
Consultar todos los envíos asociados con una dirección de email específica.
Ejemplo de Solicitud
curl --location 'https://rest-api.argosidentity.com/v3/submission?email={email}' \
--header 'x-api-key: {yourAPIKey}'
curl --location 'https://kr.rest-api.argosidentity.com/v3/submission?email={email}' \
--header 'x-api-key: {yourAPIKey}'
Ejemplo de Respuesta
result.json
{
"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"]
}
}
]
}
Para definiciones detalladas de los campos de respuesta, consulte la página de Campos de Respuesta.
Consultar todos los envíos. Se recomienda el uso de paginación.
Ejemplo de Solicitud
curl --location 'https://rest-api.argosidentity.com/v3/submission?count=50' \
--header 'x-api-key: {yourAPIKey}'
curl --location 'https://kr.rest-api.argosidentity.com/v3/submission?count=50' \
--header 'x-api-key: {yourAPIKey}'
Ejemplo de Respuesta
result.json
{
"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"
}
}
Esta llamada API devuelve todos los envíos, lo que puede incluir un gran volumen de datos. Se recomienda usar parámetros de paginación para un rendimiento óptimo.
Para definiciones detalladas de los campos de respuesta, consulte la página de Campos de Respuesta.
5. Transferencia Segura de Datos
Todos los parámetros de la solicitud, incluido submission_id, deben cifrarse como un único objeto JSON, codificarse en URL y enviarse en el parámetro de consulta
data.
Para más detalles, consulte Cifrado de Datos de Solicitud de API (AES-256-ECB).En las solicitudes POST y PATCH, el texto cifrado se envía en el cuerpo como una cadena base64 sin procesar (raw). En las solicitudes GET, el texto cifrado se codifica en URL y se envía en el parámetro de consulta
data.Ejemplo de Solicitud Cifrada
curl --location 'https://rest-api.argosidentity.com/v3/submission?data={encrypted_data}' \
--header 'x-api-key: {yourAPIKey}'
curl --location 'https://kr.rest-api.argosidentity.com/v3/submission?data={encrypted_data}' \
--header 'x-api-key: {yourAPIKey}'
Al usar Transferencia Segura de Datos, la respuesta será datos cifrados, y debe descifrarlos para leer los datos.
Solicitud Completa a Cifrar
Para proyectos con Transferencia Segura de Datos habilitada, agrupe todos los parámetros de la solicitud que vaya a usar en un único objeto JSON y cifre ese objeto. El siguiente ejemplo incluye todos los parámetros; en una solicitud real, incluya solo los que necesite:encrypt-request-params.json
{
"count": "50",
"submission_id": "string",
"email": "string",
"userid": "string",
"nextpage_id": "string",
"nextpage_date": "string",
"start_date": "YYYY-MM-DD",
"end_date": "YYYY-MM-DD",
"request_type": "kyc"
}
data.
Los parámetros en texto plano que se dejen fuera de
data se ignoran. Incluya todas las condiciones de consulta dentro del objeto cifrado.Respuesta Cifrada
La respuesta incluye una bandera isEncrypted y datos cifrados:result.json
{
"data": "encrypted-string",
"isEncrypted": true
}
6. Definiciones de Campos de Respuesta
Para definiciones detalladas de todos los campos incluidos en las respuestas de la API GET/Submission, consulte la siguiente página:Definiciones de Campos de Respuesta
Definiciones y descripciones detalladas de los campos de respuesta de la API GET/Submission
7. Códigos de Error
| Error Code | Message | Descripción |
|---|---|---|
invalid_payload | Invalid payload | No se puede analizar el cuerpo de la solicitud |
missing_data | Required input data is missing | Faltan campos requeridos |
invalid_project | Invalid project | El ID del proyecto no es válido |
invalid_admin | Invalid admin | La cuenta del administrador no tiene permisos para este proyecto |
invalid_parameter | invalid parameter: {parameter} | Parámetro inesperado enviado |
invalid_format | invalid format: ${parameter} | El parámetro no coincide con el formato esperado |
processing_error | Failed to complete migration | Ocurrió un error desconocido durante el procesamiento |