Saltar al contenido principal

​
1. Endpoint

PATCH/Submission
PATCH https://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. Cuerpo de la Solicitud

El cuerpo de la solicitud debe estar en formato JSON. A continuación se encuentran las descripciones de los campos:
​
submissionId
string
requerido
Dirección de email del administrador (debe estar registrada en el dashboard).
​
admin
string
requerido
Dirección de email del administrador (debe estar registrada en el dashboard).
Add commentMore actions
​
data
object
Objeto que contiene los campos a actualizar.

​
4. Ejemplo de Solicitud

PATCH/Submission
curl --location --request PATCH 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "submissionId": "6xx28lo115832",
  "admin": "yourAdmin@sample.com",
  "data": {
    "idType": "drivers_license",
    "issuingCountry": "KOR",
    "fullName": "hong kil dong",
    "firstName": "kil dong",
    "lastName": "hong",
    "gender": "male",
    "birthDate": "1999-11-31",
    "nationality": "USA",
    "kycStatus": "approved",
    "issueDate": "2017-10-19",
    "expireDate": "2027-10-18",
    "identityNumber": "991131-1111111",
    "documentNumber": "05-167-U0815",
    "serialNumber": "07PN10",
    "memo": "This is an example for memo"
  }
}'

​
5. Respuesta

​
5-1. Respuesta Exitosa

result.json
{
  "message": "success to edit.",
  "statusCode": 200
}

​
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",
}

​
5-3. Códigos de Error

Error CodeDescripción
API-Key is required.Falta la clave API.
The project is not found.Proyecto no encontrado.
Decryption is Failed. Please check the api-key.Fallo en el descifrado de datos.
Data Processing Error.Fallo en el cifrado de datos.
data parsing error. please check input data.Error de análisis de datos.
submissionId is required.Falta el submissionId.
projectId or x-api-key is required.Falta el projectId o x-api-key.
admin is required.Falta la información del admin.
At least one property to modify is required.No se proporcionó ninguna propiedad a modificar.
Invalid idType. Please check the idType.Tipo de ID inválido.
Invalid kyc status. Please check the kycStatus.Estado KYC inválido.
Invalid gender. Please check the gender.Valor de género inválido.
Invalid issuingCountry. Please enter a valid ISO 3166-1 alpha-3.Código de país emisor inválido.
Invalid nationality. Please enter a valid ISO 3166-1 alpha-3.Código de nacionalidad inválido.
Invalid birthDate. Please enter the date as YYYY-MM-DDFormato de fecha de nacimiento inválido.
Invalid issueDate. Please enter the date as YYYY-MM-DDFormato de fecha de emisión inválido.
Invalid expireDate. Please enter the date as YYYY-MM-DDFormato de fecha de vencimiento inválido.

​
6. Opciones de Cifrado

Para mayor seguridad, el cuerpo de la solicitud puede ser cifrado. Al usar cifrado:
  • Cifre el objeto completo del cuerpo de la solicitud.
  • Envíe la cadena cifrada como el parámetro data (no como un campo body).

​
6-1. Ejemplo de Solicitud Cifrada

patch-encrypted.py
encryption = Encryption(api_key, mode='ECB')

payload_data = {
    "admin": "yourAdmin@sample.com", 
    "submissionId": "6xx28lo115832", 
    "data": {
        "kycStatus": "approved",
        "fullName": "hong kil dong"
    }
}

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

# Send the encrypted data as the data parameter
response = requests.patch(
    url,
    headers=headers,
    data=payload_encrypted
)
PATCH/Submission (Encrypted)
curl --location --request PATCH 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data 'N34SNtWaavEfgtg1g%2Bo%2B9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw%3D%3D'

​
6-2. Respuesta Cifrada

La respuesta incluirá la bandera isEncrypted y los datos cifrados:
result.json
response : {
   body : {
    "data": "encrypted-string",
    "isEncrypted": true
   }
}