PATCH/Submission

Changing kycStatus through this API triggers the Updated webhook. The approved / rejected webhooks are not sent; the new status is delivered as a string in data.kyc_result. The same applies when a submission is edited from the dashboard.

1. Endpoint

PATCH/Submission

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

2. Authentication

Include the API key in the “x-api-key” header:

x-api-key

x-api-key: {yourAPIKey}

3. Request Body

The request body must be in JSON format. Below are the field descriptions:

string

required

Administrator’s email address (must be registered in the dashboard).

string

required

Administrator’s email address (must be registered in the dashboard).

Add commentMore actions

object

Object containing the fields to be updated.

Show Properties

string

KYC result: approved or rejected.

string

ID type. Refer to ID Card Codes.

string

Country of issue. Refer to Country Codes.

string

Full name of the KYC applicant.

string

First name of the KYC applicant.

string

Last name (family name) of the KYC applicant.

string

female or male.

string

Date of birth in YYYY-MM-DD format.

string

Applicant’s nationality. Refer to Country Codes.

string

ID issue date in YYYY-MM-DD format.

string

ID expiration date in YYYY-MM-DD format.

string

Document number of the ID.

string

Identity number of the applicant.

string

Driver’s license serial number.

string

Memo for Admin; Record in Memo from Dashboard’s Detailed information upon Request

4. Request Example

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

5-1. Success Response

result.json

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

5-2. Error Response

If an error occurs, a 400 status code is returned with details in the response body:

error.json

{
    "errorCode": "invalid_payload",
}

5-3. Error Codes

Error Code	Description
`API-Key is required.`	API key is missing.
`The project is not found.`	Project not found.
`Decryption is Failed. Please check the api-key.`	Data decryption failed.
`Data Processing Error.`	Data encryption failed.
`data parsing error. please check input data.`	Data parsing error.
`submissionId is required.`	`submissionId` is missing.
`projectId or x-api-key is required.`	`projectId` or `x-api-key` is missing.
`admin is required.`	`admin` information is missing.
`At least one property to modify is required.`	No property to modify was provided.
`Invalid idType. Please check the idType.`	Invalid ID type.
`Invalid kyc status. Please check the kycStatus.`	Invalid KYC status.
`Invalid gender. Please check the gender.`	Invalid gender value.
`Invalid issuingCountry. Please enter a valid ISO 3166-1 alpha-3.`	Invalid issuing country code.
`Invalid nationality. Please enter a valid ISO 3166-1 alpha-3.`	Invalid nationality code.
`Invalid birthDate. Please enter the date as YYYY-MM-DD`	Invalid birth date format.
`Invalid issueDate. Please enter the date as YYYY-MM-DD`	Invalid issue date format.
`Invalid expireDate. Please enter the date as YYYY-MM-DD`	Invalid expiration date format.

6. Encryption Options

For enhanced security, the request body can be encrypted. When using encryption:

Encrypt the entire request body object.
Send the encrypted string as the data parameter (not as a body field).

6-1. Encrypted Request Example

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. Encrypted Response

The response will include the isEncrypted flag and encrypted data:

result.json

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

Overview

API Reference

1. Endpoint

2. Authentication

3. Request Body

4. Request Example

5. Response

5-1. Success Response

5-2. Error Response

5-3. Error Codes

6. Encryption Options

6-1. Encrypted Request Example

6-2. Encrypted Response

​1. Endpoint

​2. Authentication

​3. Request Body

​4. Request Example

​5. Response

​5-1. Success Response

​5-2. Error Response

​5-3. Error Codes

​6. Encryption Options

​6-1. Encrypted Request Example

​6-2. Encrypted Response

1. Endpoint

2. Authentication

3. Request Body

4. Request Example

5. Response

5-1. Success Response

5-2. Error Response

5-3. Error Codes

6. Encryption Options

6-1. Encrypted Request Example

6-2. Encrypted Response