GET/Verifiedinfo

To get one or a list of submission data.

GET https://rest-api.argoskyc.com/v3/verifiedinfo

To get one or a list of submission data.

  • When queried without any parameter, the entire list will respond

  • When queried with any parameter, data that matches the parameter will respond

Input Data

  • Request with 'consent_id', refer to Sample Request: consent_id

  • Request with 'argos_id', refer to Sample Request: argos_id

  • Request for the entire list, refer to Sample Request: list

Parameter
Required
Description

consent_id

Optional

A data that matches the 'consent_id' will return.

argos_id

Optional

'argos_id', 'consent_id', 'authed_at' will return.

count

Optional

Set the number of list data to be returned. (max 2000, default 2000)

nextpage_id

Optional

When the response contains 'nextpageKey', it means there is a next page. 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.authed_at)' are mendatory parameters to call the next page.

nextpage_date

Optional

When the response contains 'nextpageKey', it means there is a next page. 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.authed_at)' are mendatory parameters to call the next page.

Output Data

  • List of response data.

  • When the entire list is requested or requested with 'argos_id', only argos_id', 'consent_id', 'authed_at' will return.

  • Requested with 'consent_id', full data will return.

Parameter
Descreiption

argos_id

ID generated with approval of KYC

consent_id

Unique ID generated with data transfer consent

request_id

A value created and transfered from client when verified by POST/idverify API to differentiate data.

authed_at

Consented time(UTC+0)

data

KYC submission data

data.email

Email

data.name

Name

data.gender

<male, female>

data.nationality

ISO alpah format 3 contry code

data.date_of_birth

'YYYY-MM-DD' format

data.address_globalCode

Address code(e.g. 87C4VXX7+39)

data.address_compoundCode

Country, city and detailed code

(e.g. VXX7+39 Washington, DC, USA)

data.address_formatted

Detailed address transformed from the code (e.g. 1600 Pennsylvania Avenue NW, Washington, DC 20500, USA)

data.address_input

User input address

data.address_detail

User input detail address

data.idcard_issuingCountry

ISO alpah format 3 contry code

data.idcard_issueDate

'YYYY-MM-DD' format

data.idcard_expireDate

'YYYY-MM-DD' format

data.id_type

<passport, government_id, drivers_license>

data.face_similarity_score

Face comparison score

data.liveness_score

Face image liveness score

argos_id_expireDate

'YYYY-MM-DD' format of 'argos_id' expiry date

network

Blockchain network data

network.name

Network name of connected wallet(in ticker format)

network.address

Wallet address

aml

Data object of aml screening result

aml.risk_level_summary

<Not Screened, High, Medium, Low>

aml.currentstatus

<Not Screened, Red Flag>

aml.matches

Detailed aml result, avalable when 'aml.currentstatus' is 'Red Flag'

aml.matches[i].risk_level

Risk level, <HIGH, MEDIUM, LOW>

aml.matches[i].argos_number

ID to call the aml report(Deprecated)

aml.matches[i].resource_id

ID to call the aml report

aml.matches[i].risk_icons

Risk icons

nextpageKey

Object returned when there is a next page

nextpageKey.id

Last ID needed to call the next page

nextpageKey.authed_at

Last authed data needed to call the next page (UTC+0)

This part will explain how to inquire user data with 'consent_id'

  • URL and x-api-key are required

curl --location --request GET 'https://rest-api.argoskyc.com/v3/verifiedinfo' \
--header 'x-api-key: {yourAPIKey}'
  • Sample data to query authentication data

  • Should be called by parameters

  • Only one profile will be returned

curl --location --request GET 'https://rest-api.argoskyc.com/v3/verifiedinfo?consent_id={consent_id}'\
--header "x-api-key: {yourAPIKey}"
  • Sample of authed data

  • The response will contain 'argos_id', KYC completed data, wallet address, AML result, authed date and expiry date of 'argos_id'

{
    "Items": [
        {
            "argos_id": "{argos_id}",
            "consent_id": "{consent_id}",
            "request_id": "{request_id}",
            "authed_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "data": {
                "name": "TEST",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD",
                "address_globalCode": "{your address globalCode}",
                "address_input": "{your input address}",
                "address_detail": "{your detail address}",
                "idcard_issuingCountry": "KOR",
                "idcard_issueDate": "YYYY-MM-DD",
                "id_type": "government_id",
                "face_similarity_score": 99,
                "liveness_score": 82
            },
            "argos_id_expireDate": "YYYY-MM-DD",
            "email": "{email}",
            "network": [
                {
                    "name": "ETH",
                    "address": "{your network address}"
                },
                {
                    "name": "SOL",
                    "address": "{your network address}"
                },
                {
                    "name": "KLAY",
                    "address": "{your network address}"
                }
            ]
        }
    ]
}

Sample - argos_id

This part will explain how to inquire user data with 'argos_id'

Request URL: argos_id

  • URL and x-api-key are required

curl -X GET "https://rest-api.argoskyc.com/v3/verifiedinfo?argos_id={argos_id}"\
-H "x-api-key: {yourAPIKey}"

Sample Request: argos_id

  • It will return all data that matches the 'argos_id'

curl --location --request GET 'https://rest-api.argoskyc.com/v3/verifiedinfo?argos_id={argos_id}' \
--header 'x-api-key: {yourAPIKey}'

Sample Response: argos_id

  • Sample data of profiles with the same 'argos_id'

  • It will only return 'argos_id', 'consent_id' and 'authed_at' parameter

{
    "Items": [
        {
            "argos_id": "{argos_id}",
            "consent_id": "{consent_id}",
            "authed_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
        },
        
            "argos_id": "{argos_id}",
            "consent_id": "{consent_id}",
            "authed_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
        },
        {
            "argos_id": "{argos_id}",
            "consent_id": "{consent_id}",
            "authed_at": "YYYY-MM-DD-HH-MM-SS-ZZZ"
        },
     ]
}

Sample - List

This part will explain how to inquire user data list

Request URL: list

  • URL and x-api-key are required

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

Sample Request: list

  • It will query data for all authenticated profiles

curl --location --request GET 'https://rest-api.argoskyc.com/v3/verifiedinfo' \
--header 'x-api-key: {yourAPIKey}'

Sample Response: list

  • Sample data for all authenticated profiles.

  • It will return 'argos_id', 'consent_id', 'authed_at'.

{
    "Items": [
        {
            "argos_id": "1234-ABAB-1A2B-123A",
            "consent_id": "6hd6gv9l6w396w3",
            "authed_at": "2022-08-16T11:15:25.347Z"
        },
        {
            "argos_id": "ABAB-1234-1A2B-123A",
            "consent_id": "6hd6gv9l6w38ihb",
            "authed_at": "2022-08-16T11:14:53.711Z"
        },
        {
            "argos_id": "ABAB-1234-1A2B-B242",
            "consent_id": "6hd6gv9l6w37wwl",
            "authed_at": "2022-08-16T11:14:25.748Z"
        }
    ]
}

Last updated