POST/Submission

Esta API es particularmente útil para migrar datos de usuarios de sistemas existentes al sistema ARGOS o en casos especiales donde es necesario el envío directo de datos de verificación de identidad de usuario. También puede ayudar en la prueba de varios escenarios durante el desarrollo.

Los envíos creados usando esta API no pasan por el proceso de verificación estándar de ARGOS. La precisión y validez de los datos enviados es enteramente responsabilidad del cliente. Por lo tanto, esta API no debería reemplazar el proceso regular de verificación de identidad y se recomienda solo para casos de uso excepcionales.

1. Endpoint

POST https://rest-api.argosidentity.com/v3/submission/migration

POST https://kr.rest-api.argosidentity.com/v3/submission/migration

2. Autenticación

Incluya la clave API en el encabezado x-api-key:

x-api-key

x-api-key: {yourAPIKey}

3. Cuerpo de la Solicitud

El cuerpo de la solicitud debe estar en formato JSON. A continuación se encuentran las descripciones de los campos:

string

requerido

Email del administrador del proyecto (debe estar registrado en el dashboard).

string

requerido

Dirección de email del remitente KYC.

string

requerido

Nombre completo del remitente KYC.

string

Nombre del remitente.

string

Apellido del remitente.

string

requerido

Fecha de nacimiento del remitente KYC.

string

requerido

Resultado KYC: approved o rejected.

string

Tipo de ID Códigos de Tarjeta de ID.

string

País emisor de los Códigos de País de ID.

string

Nacionalidad del remitente KYC Códigos de País.

string

female o male.

string

Fecha de emisión del ID en formato YYYY-MM-DD.

string

Fecha de vencimiento del ID en formato YYYY-MM-DD.

string

Dirección IP del remitente KYC.

string

Número de identidad del remitente KYC.

string

Número de documento del remitente KYC.

string

Ciudad de residencia.

string

País de residencia.

string

Estado/Provincia de residencia.

string

Dirección de calle.

string

Dirección completa.

string

Campo personalizado #1.

string

Campo personalizado #2.

string

Campo personalizado #3.

string

ID único de usuario.

4. Ejemplo de Solicitud

curl --location 'https://rest-api.argosidentity.com/v3/submission/migration' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {yourAPIKey}' \
--data-raw '{
  "admin": "{admin}",
  "email": "{email}",
  "fullName": "{fullName}",
  "firstName": "{firstName}",
  "lastName": "{lastName}",  
  "birthDate": "{birthDate}",
  "kycStatus": "approved",
  "idType": "drvlic",
  "issuingCountry": "USA",
  ...
}'

curl --location 'https://kr.rest-api.argosidentity.com/v3/submission/migration' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {yourAPIKey}' \
--data-raw '{
  "admin": "{admin}",
  "email": "{email}",
  "fullName": "{fullName}",
  "firstName": "{firstName}",
  "lastName": "{lastName}",  
  "birthDate": "{birthDate}",
  "kycStatus": "approved",
  "idType": "drvlic",
  "issuingCountry": "USA",
  ...
}'

5. Respuesta

5-1. Respuesta Exitosa

result.json

{
    "message": "success",
    "submissionId": "submissionId123"
}

5-2. Respuesta de Error

Si ocurre un error, se devuelve un código de estado 400 con detalles en el cuerpo de la respuesta:

error.json

{
    "errorCode": "invalid_payload",
    "message": "Invalid payload."
}

5-3. 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	Uno o más campos requeridos están faltantes
`invalid_project`	Invalid project	El ID del proyecto no es válido
`invalid_admin`	Invalid admin	La cuenta del administrador carece de 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

6. Opciones de Cifrado

Para mejorar la seguridad, el cuerpo de la solicitud puede ser cifrado. Cifre el objeto completo del cuerpo de la solicitud e incluya la cadena cifrada tal cual como cuerpo de la solicitud HTTP. No la envuelva en un objeto JSON ni en un campo data, y no la codifique en URL.

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. Para el método de cifrado, consulte Cifrado de Datos de Solicitud de API (AES-256-ECB).

6-1. Ejemplo de Solicitud Cifrada

post-encrypted.py

encryption = Encryption(api_key, mode='ECB')

payload_data = {
    "admin": "yourAdmin@sample.com",
    "email": "user@example.com",
    "fullName": "hong kil dong",
    "firstName": "kil dong",
    "lastName": "hong",
    "birthDate": "1999-11-31",
    "kycStatus": "approved",
    "idType": "drivers_license",
    "issuingCountry": "KOR"
}

# Encrypt the entire payload
payload_encrypted = encryption.encrypt(payload_data)

# Send the ciphertext string as the raw request body (no JSON wrapping, no URL encoding)
response = requests.post(
    url,
    headers=headers,
    data=payload_encrypted
)

curl --location 'https://rest-api.argosidentity.com/v3/submission/migration' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data 'N34SNtWaavEfgtg1g+o+9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw=='

curl --location 'https://kr.rest-api.argosidentity.com/v3/submission/migration' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data 'N34SNtWaavEfgtg1g+o+9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw=='

6-2. Respuesta Cifrada

La respuesta incluye una bandera isEncrypted y los datos cifrados:

result.json

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

Descripción General

Referencia API

1. Endpoint

2. Autenticación

3. Cuerpo de la Solicitud

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error

6. Opciones de Cifrado

6-1. Ejemplo de Solicitud Cifrada

6-2. Respuesta Cifrada

​1. Endpoint

​2. Autenticación

​3. Cuerpo de la Solicitud

​4. Ejemplo de Solicitud

​5. Respuesta

​5-1. Respuesta Exitosa

​5-2. Respuesta de Error

​5-3. Códigos de Error

​6. Opciones de Cifrado

​6-1. Ejemplo de Solicitud Cifrada

​6-2. Respuesta Cifrada

1. Endpoint

2. Autenticación

3. Cuerpo de la Solicitud

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error

6. Opciones de Cifrado

6-1. Ejemplo de Solicitud Cifrada

6-2. Respuesta Cifrada