GET/verifiedinfo

단 건 혹은 전체 제출 목록을 가져옵니다.

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

단건 혹은 전체 제출 목록을 가져옵니다.

매개 변수를 입력하지 않으면 모든 인증 정보를 조회합니다.
매개 변수를 입력할 경우 입력된 매개 변수를 기준으로 정보를 조회합니다.

Input Data

데이터 조회에 이용할 수 있는 매개변수들을 설명합니다.
'consent_id'로 조회 시 Sample Request: consent_id 를 확인해 주세요.
'argos_id'로 조회 시 Sample Request: argos_id를 확인해 주세요.
전체 리스트 조회 시 Sample Request: list를 확인해 주세요.

파라미터

필수 여부

설명

consent_id

옵션

일치하는 consent_id를 가진 단건 기록이 반환됩니다.

argos_id

옵션

'argos_id', 'consent_id', 'authed_at' 데이터가 반환 됩니다.

count

옵션

리스트 출력 요청 시 전달 받을 데이터 건수 설정이 가능합니다. (최대 2000개, 기본 2000개)

nextpage_id

옵션

응답에 'nextpageKey'가 리턴 되면 다음 페이지가 있음을 의미합니다. 다음 페이지를 호출하기 위해서는 요청 파라미터에 nextpage_id(nextpageKey.id)와 nextpage_date(nextpageKey.authed_at)를 모두 포함해야 합니다.

nextpage_date

옵션

응답에 nextpageKey가 리턴 되면 다음 페이지가 있음을 의미합니다. 다음 페이지를 호출하기 위해서는 요청 파라미터에 nextpage_id(nextpageKey.id)와 nextpage_date(nextpageKey.authed_at)를 모두 포함해야 합니다.

Output Data

조회 시 확인할 수 있는 데이터의 목록입니다.
전체 목록 혹은 'argos_id'로 조회할 경우 'argos_id', 'consent_id', 'authed_at' 데이터만 확인할 수 있습니다.
'consent_id'로 조회 시 모든 데이터를 확인할 수 있습니다.

응답

설명

argos_id

KYC 인증이 완료 되면 생성되는 ID

consent_id

약관 동의까지 완료 되어 생성된 프로필의 고유 ID

request_id

POST /idverify API 방식으로 인증 시 사용자 구분을 위해 고객사가 만들어 전달한 값

authed_at

약관 동의까지 완료 되어 ARGOS ID 데이터가 전달된 시간(UTC+0 기준)

data

KYC 제출 데이터

data.email

이메일

data.name

이름

data.gender

<male, female>

data.nationality

3글자 형식의 국가코드 (ISO alpha3 형식)

data.date_of_birth

YYYY-MM-DD의 형식의 생년월일

data.address_globalCode

전체 주소에 대한 상세코드 값 (e.g. 8Q98HXPG+MP)

data.address_compoundCode

국가 및 도시와 상세주소 코드 값 (e.g. HXPG+MP Seoul, South Korea)

data.address_formatted

상세 코드를 변환한 주소 (e.g. 1 Sejongno, Jongno-gu, Seoul, South Korea)

data.address_input

사용자 입력 주소 값

data.address_detail

사용자 입력 상세 주소 값

data.idcard_issuingCountry

제출된 idcard의 3글자 형식의 신분증 발급 국가 (ISO alpha3 형식)

data.idcard_issueDate

YYYY-MM-DD의 형식의 신분증 발급 일자

data.idcard_expireDate

YYYY-MM-DD 형식의 신분증 만료 일자

data.id_type

신분증 종류<passport, government_id, drivers_license>

data.face_similarity_score

얼굴 비교 점수 값

data.liveness_score

liveness 점수 값

argos_id_expireDate

YYYY-MM-DD 형식의 생성된 'argos_id'의 만료 기간 ('argos_id'가 생성된 시점부터 3년)

network

Blockchain network 데이터

network.name

연결된 지갑의 네트워크 이름 (ticker로 표기)

network.address

연결된 지갑의 주소

aml

aml 스크리닝 결과 데이터 오브젝트

aml.risk_level_summary

aml.currentstatus

aml.matches

상세 AML 스크리닝 결과. aml.currentstatus가 ‘Red Flag’일때만 이용 가능합니다.

aml.matches[i].risk_level

Red Flag 위험도 <HIGH, MEDIUM, LOW>

aml.matches[i].argos_number

AML 보고서를 조회하기 위한 고유 ID(구 버전, 사용을 권고하지 않음)

aml.matches[i].resource_id

AML 보고서를 조회하기 위한 리소스 ID

aml.matches[i].risk_icons

Red Flag 핵심 리스크 데이터

nextpageKey

추가로 출력될 다음 페이지가 있을 경우에 전달 되는 키 값 오브젝트

nextpageKey.id

다음 페이지 호출시 필요한 가장 마지막으로 조회 되었던 id 값

nextpageKey.authed_at

다음 페이지 호출시 필요한 가장 마지막으로 조회 되었던 authed_at 값 (UTC+0 기준)

Sample - consent_id

'consent_id'(인증 ID)로 정보를 조회하는 법에 대해 설명합니다.

Request URL: consent_id

URL과 x-api-key 를 반드시 입력해 주어야 합니다.

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

Sample Request: consent_id

생성된 프로필의 인증 정보를 조회하기 위한 샘플 데이터입니다.
Parameter로 제출해야 합니다.
단 건 조회만 가능합니다.

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

Sample Response: consent_id

인증 정보 조회 샘플 데이터입니다.
'argos_id', KYC 신원 인증 완료 데이터, 지갑 주소, AML결과, 인증 완료 날짜와 '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": "홍길동",
                "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

'argos_id'로 정보를 조회하는 법에 대해 설명합니다.

Request URL: argos_id

URL과 x-api-key를 반드시 입력해 주어야 합니다.

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

Sample Request: argos_id

해당 argos id를 가진 모든 프로필의 데이터를 조회합니다.

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

Sample Response: argos_id

해당 argos id를 가진 모든 프로필의 조회 샘플 데이터 입니다.
해당 argos id를 가진 모든 프로필의 argos_id, consent_id, authed_at 데이터를 확인할 수 있습니다.

{
    "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

list 로 정보를 조회하는 법에 대해 설명합니다.

Request URL: list

URL과 x-api-key를 반드시 입력해 주어야 합니다.

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

Sample Request: list

인증이 완료된 모든 프로필의 데이터를 조회합니다.

curl --location --request GET 'https://rest-api.argoskyc.com/v3/verifiedinfo?argos_id={1234-ABAB-1A2B-123A}' \
--header 'x-api-key: {hTycjfhzOY2SKr3m7qHFg4QhGn43MOqPaB2....}'

Sample Response: list

인증이 완료된 모든 프로필의 조회 샘플 데이터 입니다.
인증 완료된 모든 프로필의 '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"
        }
    ]
}

PreviousNotes NextGET/verifiedimage

Last updated 1 year ago