​
1. Base URL

GET/FaceAuth
https://rest-api.argosidentity.com/v3/faceauth

​
2. Authentication

Include the API key in the x-api-key header:

x-api-key
x-api-key: {yourAPIKey}

​
3. Request Example

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

​
4. Request Parameters

​
authId
string

Used for retrieving a specific submission. If authId is provided, only the corresponding submission is returned; otherwise, the full list is retrieved.

​
startDate
string

Start date of the query (yyyy-mm-dd format). To filter data within a specific period, both startDate and endDate must be provided.

​
endDate
string

End date of the query (yyyy-mm-dd format).

​
nextKey_id
string

The authId value from the nextPage_key object in the response of the previous request.

​
nextKey_date
string

The createTime value from the nextPage_key object in the response of the previous request.

​
count
string

Specifies the number of data entries to retrieve (minimum 1, maximum 2,000). If not provided, the default value is 2,000.

  • Maximum retrieval limit: A single request can retrieve up to 2,000 entries.
  • Fetching additional data: If more data is available, the response includes the nextPage_key object. To continue retrieving data, use nextPage_key’s authId as nextKey_id and createTime as nextKey_date in the next request.

​
5. Response

​
5-1. Response (delete_check: false)

result.json
[
  {
    "auth_id" : "sampleId1", 
    "auth_status" : "approved",
    "create_time" : "2023-08-18T15:00:00.000Z",
    "submit_type" : "sampleType",
    "kyc_submission_id" : "sampleKycId1",
    "policy" : {
        "faceSimilarity_threshold" : 70,
        "occluded_threshold" : false, 
        "faceCover_threshold" : 0,
        "headCover_threshold" : 50
    },
    "delete_check": false
  }
]

​
5-2. Response (delete_check: true)

result.json
[     
  { 
    "auth_id" : "sampleId1", 
    "auth_status" : "approved",
    "create_time" : "2023-08-18T15:00:00.000Z",
    "submit_type" : "sampleType",
    "kyc_submission_id" : "sampleKycId1",
    "policy" : {
        "faceSimilarity_threshold" : 70,
        "occluded_threshold" : false, 
        "faceCover_threshold" : 0,
        "headCover_threshold" : 50
    },
    "delete_check": true,
    "delete_time": "2023-09-04T02:19:01.399Z"
  }
]

​
5-3. Response Data

​
faceAuth_projectId
string

FaceAuth project ID

​
data
array

List of retrieved submissions

​
6. Error Codes

If an error occurs, a 400 status code is returned along with details in the response body:

error.json
{
    "errorCode": "required key is missing"
}
Error CodeDescription
faceAuth_project not foundThe submitted API-Key does not match any valid project. Please check if your API-Key is correct.

Was this page helpful?

POST/FaceauthDELETE/Faceauth