This API is particularly useful for project administrators who need to manually review pending KYC submissions based on their project configuration. When the reviewer is set to ‘Client’ in project settings, ARGOS Agents will not review these pending submissions.
Only pending submissions can be reviewed using this API. Submissions that are already approved or rejected cannot be modified through this endpoint. Ensure that the admin email is registered in the dashboard with proper permissions for the project.
1. Endpoint
2. Authentication
Include the API key in the x-api-key header:x-api-key
3. Request Body
The request parameters should be in URL query format. Below are the field descriptions for each parameter:Admin account registered as an administrator in the project of the submission to be reviewed
Unique ID of the pending submission to be reviewed
Status value to be changed:
approved
or rejected
Comment explaining the review decision (optional). Required when status is
rejected
Data fields to be updated
4. Request Example
POST/Review
5. Response
5-1. Success Response
result.json
5-2. Error Response
If an error occurs, a400
status code is returned with details in the response body:
error.json
5-3. Error Codes
Error Type | Message | Description |
---|---|---|
Validation : project | Project not found. | Invalid api-key or project data |
Validation : project | admin is required. | admin parameter not provided |
Validation : project | Access denied. The admin is not registered in the project. | admin not registered in project or invalid admin data |
Validation : submission | Submission Id is required. | submission ID not provided |
Validation : submission | Invalid Submission Id. | Invalid submission data |
Validation : submission | Only submissions in pending status can be reviewed | submission is not in pending status |
Validation : submission | This submission cannot be reviewed by client | submission not eligible for client review |
Validation : request parameter | Invalid status | status must be ‘approved’ or ‘rejected’ |
Validation : request parameter | Invalid data format. | updateFields format is incorrect (object required) |
Validation : request parameter | Reject comment is required | rejectedComment required when changing status to rejected |
Validation : request parameter | Invalid idType | Invalid idType |
Validation : request parameter | Invalid gender | Invalid gender |
Validation : request parameter | Invalid issueDate format. Use YYYY-MM-DD | Invalid date format (yyyy-mm-dd required) |
Validation : request parameter | Invalid expireDate format. Use YYYY-MM-DD | Invalid date format (yyyy-mm-dd required) |
Validation : request parameter | Invalid birthDate format. Use YYYY-MM-DD | Invalid date format (yyyy-mm-dd required) |
Processing Error | Failed to process submission | Undefined error occurred during data processing |
Processing Error | Error in submission review process. | Undefined error occurred during review processing |