PATCH/Submission

• Modify the information of single-submission data.

• The modified data can be edited again, but cannot be restored to its original state.

Request URL

• You must provide the URL and x-api-key.

curl -X PATCH "https://rest-api.argosidentity.com/v3/submission" \
-H "x-api-key: {yourAPIKey}" \

Sample Request 1

• This is a sample request to modify the submitted KYC (Know Your Customer) data.

curl --location --request PATCH 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}'

Sample Request 2

• This is a sample data for a modification request submission. (Body)

{
  "submissionId": "6xx28lo115832",
  "admin": "[e-mail]",
  "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"
		}
}

Sample Response

• This is sample data that can be used to verify the completion of the modification.

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

Input Data

• An explanation of the parameters for modifying KYC data (submission).

• It is essential to strictly adhere to the specified Value format.

Parameter	Required	Type	Value format	Description
submissionId	required*	string		Submission ID. Unique ID for each submission.
admin	required*	string		Administrator (email) account registered in the project.
data	required*	object		An object containing the data items you want to modify. It must include at least one of the following properties.
data.kycStatus	Optional	string	-approved -rejected	KYC result modification.
data.idType	Optional	string	-passport -drivers_license -government_id -residence_permit -vehicle_registration_certificate -visa -aadhaar -pancard	ID document type modification: Choose one from the Value format options.
data.issuingCountry	Optional	string	-KOR, USA, JPN … -ISO Alpha3 Country Code	ID document issuing country modification: Enter a valid ISO 3 code (ISO 3166-1 alpha-3).
data.fullName	Optional	string	-hong kil dong	Full Name modification.
data.gender	Optional	string	-female -male	Gender modification.
data.birthDate	Optional	string	YYYY-MM-DD	Birthdate modification.
data.nationality	Optional	string	-KOR, USA, JPN … -ISO Alpha3 Country Code	Nationality modification: Enter a valid ISO3 code (ISO 3166-1 alpha-3).
data.issueDate	Optional	string	YYYY-MM-DD	Issue date modification.
data.expireDate	Optional	string	YYYY-MM-DD	Expiration date modification.
data.documentNumber	Optional	string	“50-11-J11354”	Document number modification: Input format (the entire string including '-')
data.identityNumber	Optional	string	“983155-1111001”	Identity number modification: Input format (the entire string including '-')
data.serialNumber	Optional	string	“07PN10”	Serial number modification: Input format (the entire string including '-')

Using Encryption Option for Input Data

June 21, 2024

When using the encryption option, both input and output require bidirectional encryption/decryption.

Encrypt the Request Body for API Request:

body: encrypt({
    email: 'string',
    fullName: 'string',
    issuingCountry: 'string',
    birthDate: 'string',
    ...
})

---

Output Data

• List of data returned when modifying KYC data (submission).

Response	Description
message	Success or failure status value for KYC data modification.

Using Encryption Option for Output Data

Return the encrypted result in the data property within the Body object.

Example:

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