PATCH/Submission

Cambiar kycStatus mediante esta API activa el webhook Updated. Los webhooks approved / rejected no se envían; el nuevo estado se entrega como una cadena en data.kyc_result. Lo mismo aplica cuando la solicitud se edita desde el panel.

1. Endpoint

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

PATCH 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. 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

Dirección de email del administrador (debe estar registrada en el dashboard).

string

requerido

Dirección de email del administrador (debe estar registrada en el dashboard).

Add commentMore actions

object

Objeto que contiene los campos a actualizar.

Mostrar Propiedades

string

Resultado KYC: approved o rejected.

string

Tipo de ID. Consulte Códigos de Tarjeta de ID.

string

País de emisión. Consulte Códigos de País.

string

Nombre completo del solicitante KYC.

string

Nombre del solicitante KYC.

string

Apellido del solicitante KYC.

string

female o male.

string

Fecha de nacimiento en formato YYYY-MM-DD.

string

Nacionalidad del solicitante. Consulte Códigos de País.

string

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

string

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

string

Número de documento del ID.

string

Número de identidad del solicitante.

string

Número de serie de la licencia de conducir.

string

Memo para el Administrador; se registra en Memo desde la información detallada del Dashboard al realizar la solicitud

4. Ejemplo de Solicitud

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"
  }
}'

curl --location --request PATCH 'https://kr.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 Code	Descripció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-DD`	Formato de fecha de nacimiento inválido.
`Invalid issueDate. Please enter the date as YYYY-MM-DD`	Formato de fecha de emisión inválido.
`Invalid expireDate. Please enter the date as YYYY-MM-DD`	Formato de fecha de vencimiento inválido.

6. Opciones de Cifrado

Para mayor 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

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 ciphertext string as the raw request body (no JSON wrapping, no URL encoding)
response = requests.patch(
    url,
    headers=headers,
    data=payload_encrypted
)

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

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

6-2. Respuesta Cifrada

La respuesta incluirá la 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