​
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:

​
submissionId
string
required

Unique ID of the submission to be modified.

​
admin
string
required

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

​
data
object
required

Object containing the fields to be updated.

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

​
5. Response

​
5-1. Success Response

result.json
{
    "message": "Data Processing Success."
}

​
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 CodeDescription
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-DDInvalid birth date format.
Invalid issueDate. Please enter the date as YYYY-MM-DDInvalid issue date format.
Invalid expireDate. Please enter the date as YYYY-MM-DDInvalid 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 body parameter.

​
6-1. Encrypted Request Example

result.json
body : encrypt({
		submissionId : 'string',
		admin : 'string',
		data : {
            ...
        }
	})

​
6-2. Encrypted Response

The response will include the isEncrypted flag and encrypted data:

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

Was this page helpful?

POST/SubmissionGET/Submission