POST/Submission
Last updated
Last updated
Rather than proceed with ARGOS ID check, the client company creates a submission by forcibly inserting the user's KYC data directly.
This API can only insert String data, and image data must use the ‘Put Image’ API separately.
Submissions created with this API do not undergo any OCR or verification.
Parameter | Type | Required | Description |
---|---|---|---|
Encrypt the Request Body before making an API request.
Example:
Return the encrypted result in the data
property within the Body object.
Example :
You must enter the URL and x-api-key.
Sample Request
Submit in Body/Raw Json format.
Only one submission is allowed.
Sample Response
Response | Description |
---|---|
errorCode | Message | Description |
---|---|---|
admin
String / email
O
Project manager's account (must be registered in the dashboard)
String / email
O
Email address of KYC submitter
fullName
String
O
Email name of KYC submitter
birthDate
String / date
O
KYC submitter's date of birth (YYYY-MM-DD)
kycStatus
String (*Fixed)
O
KYC result (approved | rejected) Choose 1
idType
String (*Fixed)
O
KYC submitter's ID card type (drivers_license | government_id | passport | residence_permit | vehicle_registration_certificate | visa | aadhaar | pancard) Choose 1
issuingCountry
String (*Fixed)
O
KYC submitter's ID card issuing country (ISO alpha3 format)
nationality
String (*Fixed)
X
Nationality of KYC submitter (ISO alpha3 format)
gender
String (*Fixed)
X
Select 1 gender of KYC submitter (female | male)
issueDate
String / date
X
KYC submitter’s ID card issuance date (YYYY-MM-DD)
expireDate
String / date
X
KYC submitter's ID expiration date (YYYY-MM-DD)
ipAddress
String
X
IP address of KYC submitter
identityNumber
String
X
Resident registration number of the KYC submitter
documentNumber
String
X
KYC submitter’s document number
address_city
String
X
Address - city
address_country
String
X
Address - country
address_state
String
X
Address - state
address_street
String
X
Address - street
address_full
String
X
Address - full address
cf1
String
X
custom field 1
cf2
String
X
custom field 2
cf3
String
X
custom field 3
userid
String
X
User unique ID
submissionId
Unique ID of the generated submission (= Submission Id)
invalid_payload
Invalid payload.
Request body (payload) is not verified
missing_data
Required input data is missing.
Required parameter is missing
invalid_project
Invalid project.
Invalid project ID
invalid_admin
Invalid admin.
Admin account without permission for the project
invalid_parameter
invalid parameter: {parameter}
Submit parameters not provided in input data
invalid_format
invalid format: ${parameter}
It does not fit the data format indicated in Input data.
processing_error
Failed to complete migration.
Unknown error while processing data. (CS manager inquiry)