Get a list of approved submissions submitted by the same person.
If there are multiple submissions from people with the same name, date of birth, nationality, gender, and face, it is judged as duplicate submission, and you can check the duplicate submissions.
For a typical applicant that doesn't have duplicate submissions, only a single approved submission is pulled.
Since the search is based on applicant_id, applicant_id must be obtained from submission information through GET/Submission API.
'applicant_id' is a combination of name, date of birth, gender, nationality and face image. .
Submission data with the same 5 data will have the same 'applicant_id'.
'applicanat_id' is generated randomly if no comparison is found.
Request URL
curl -X GET "https://rest-api.argosidentity.com/v3/submission/applicant?applicant_id={applicant_id}"
-H "x-api-key: {yourAPIKey}"
Input Data
* means required parameters.
Output Data
Sample Reuqest
curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission/applicant?applicant_id={applicant_id}' \
--header 'x-api-key: {yourAPIKey}'
Submission ID. A single submission data matching the submission ID is returned.
userid
A list of submissions matching the userid is returned. The userid is an optional parameter that is inserted into submission data when posting a submission.
email
A list of submissions matching the email address is returned.
count
When retrieving a list via userid, if the user has not specified a count, the default value will be set to 50.
nextpage_id
If 'nextpageKey' is returned to the response when requesting list output, it means that there is a next page.
To call the next page, 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.created_at) should be included to the request parameter.
nextpage_date
If 'nextpageKey' is returned to the response when requesting list output, it means that there is a next page. To call the next page, 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.created_at) should be included to the request parameter.
start_date
Start date of querying period(YYYYMMDD)
end_date
End date of querying period(YYYYMMDD)
request_type
Selectively query certain items. Available options are { kyc, aml, data, others }
aml: aml. sub data + submission_id
kyc: kyc. sub data + submission_id
data: data. sub data + submission_id
others: Rest of the data except for aml, kyc, data.
data
KYC applicant data
data.name
name
data.gender
<male, female>
data.nationality
Three letter format (ISO alpha3 format) of nationality.
ISO alpha 3 format country code where ID card is issued.
data.idcard_issueDate
YYYY-MM-DD format of ID card issue date
data.idcard_expireDate
YYYY-MM-DD format of ID card expiry date
data.identityNumber
Personal Identity Number
data.documentNumber
Documnet number
data.address_city
City
data.address_country
Country
data.address_state
State
data.address_street
Street
data.address_zipcode
Zip code (postal code)
data.address_globalCode
Detailed code from the address
(ex. 87C4VXX7+39)
data.address_compoundCode
Detailed code, city and country from the address
(ex. VXX7+39 Washington, DC, USA)
data.address_formatted
Transformed address from detailed code
data.address_input
User input address
data.address_detail
User input detailed address
data.cf1
Optional parameter that is inserted into submission data when posting a submission.
data.cf2
Optional parameter that is inserted into submission data when posting a submission.
data.cf3
Optional parameter that is inserted into submission data when posting a submission.
email
email address
reviewer
system: when reviewed by AI
agent: when reviewed by human
submission_id
Identifier given to each submission
applicant_id
Identifier given to duplicated applicant
created_at
KYC submitted date and time.
kyc_result_at
Time when the KYC result is first determined, it will be transmitted only when the result is 'approved/rejected'. (UTC+0)
updated_at
The most recent time when the submission was updated. (UTC+0)
pending_at
Time when a submission was turned into 'pending' status. (UTC+0)
userid
Optional parameter that is inserted into submission data when posting a submission.
additional_list
This field contains data entered by users during the KYC process, applicable to the Additional form set in the dashboard. The data is included for the following request types:
- When queried by a specific submissionId or email
- When ‘request_type’ is set to ‘others’
additional_list.answer
Name of each item in the Additional form
additional_list.inputValue
User input value for each item
additional_list.blockType
Data type of each item
kyc
KYC data object
kyc.result
<incomplete, pending, approved, rejected>
incomplete: KYC submission is incomplete due to insufficient data.
pending: the submission is under manual review
approved: submission is approved
rejected: submission is rejected. Reject comment can be found at "kyc.comment".