POST/Submission

Definition

  • 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.

Input Data

Parameter
Type
Required
Description

admin

String / email

O

Project manager's account (must be registered in the dashboard)

email

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

Using Encryption Option for Input Data

Encrypt the Request Body before making an API request.

Example:

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

Output Data

Response
Description

submissionId

Unique ID of the generated submission (= Submission Id)

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
    }
}


Error Codes (400 error)

errorCode
Message
Description

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)

Request URL

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

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

Sample Request

  • Submit in Body/Raw Json format.

  • Only one submission is allowed.

curl --location '<https://rest-api.argosidentity.com/v3/submission/migration>' \\
--header 'Content-Type: application/json' \\
--header 'x-api-key: {yourAPIKey}' \\
--data-raw '{
  "admin": "admin@sample.com",
  "email": "migration@sample.com",
  "fullName": "홍길동",
  "birthDate": "2002-11-08",
  "issuingCountry": "KOR",
  "idType": "drivers_license",
  "kycStatus": "approved",
  "identityNumber": "021108-2222555",
  "nationality": "USA",
  "gender": "male",
  "issueDate": "2011-08-07",
  "expireDate": "2025-08-07",
  "documentNumber": "504862-11-20",
  "address_city": "Springfield",
  "address_country": "United states",
  "address_state": "Ohio",
  "address_street": "street 1-10",
  "address_full": "street 1-10, Springfield, Ohio",
  "cf1": "migration-comment1",
  "cf2": "migration-comment2",
  "cf3": "migration-comment3",
  "userid": "migrated-user2"
}
'

Sample Response

{
    "message": "success",
    "submissionId": "submissionId2_mg"
}

Last updated