Get/Submission

• GET 요청을 통해 KYB 상세 데이터(AML 결과 포함)와 제출 목록을 확인할 수 있습니다.

• 'submission_id'를 입력해 단 건을 조회할 수 있으며, 해당 파라미터가 공란으로 요청되면 기본값으로 여러 건이 조회되며 100개의 리스트를 출력합니다.

• 'submission_id'는 각 제출 건의 고유 식별 ID입니다.

Input data

데이터를 조회하기 위해서 필요한 매개 변수들에 대해 설명합니다.

• 단 건 조회 시 'Submission ID로 단 건조회하기' 부분을 참고해주세요.

• 복수 건 조회 시 'List로 여러 건 조회하기' 부분을 참고해 주세요.

Parameter	requirement	Description
submission_id	optional	각 제출건이 가지는 고유 식별 ID
count	optional	리스트에 출력할 데이터 건수, 디폴트로 최대값인 100개가 출력
start_date	optional	기간 조회 시 시작 날짜 (YYYY-MM-DD)
end_date	optional	기간 조회 시 종료 날짜 (YYYY-MM-DD)
nextpage_id	optional	응답에 nextpageKey가 리턴되는 경우, 다음 페이지가 있음을 의미합니다. 다음 페이지를 호출하기 위해 nextpage_id(nextpageKey.id)와 nextpage_date(nextpageKey.created_at)를 함께 요청해 주세요.
nextpage_date	optional	응답에 nextpageKey가 리턴되는 경우, 다음 페이지가 있음을 의미합니다. 다음 페이지를 호출하기 위해 nextpage_id(nextpageKey.id)와 nextpage_date(nextpageKey.created_at)를 함께 요청해 주세요.

Output Data

• 'representative' 오브젝트에는 KYB 제출자의 신원정보, 제출자 유형, 제출 상태 등의 정보를 담고 있습니다.

• 'AML' 오브젝트에는 법인에 대한 AML결과를 담고 있습니다.

• 'directors' 오브젝트에는 이사진의 신원정보, 이사진에 대한 AML 결과를 담고 있습니다.

• 'shareholders' 오브젝트에는 실제 소유자의 신원정보, 실제 소유자에 대한 AML 결과를 보여줍니다.

• 'note' 오브젝트는 진행 상황에 대한 메모를 담고 있습니다.

Response	Description
projectId	프로젝트 고유 아이디
submissionId	제출 데이터의 고유 아이디
company_name	법인 이름
company_id	고객사가 대상 법인에게 선택적으로 부여한 ID
created_at	제출 데이터의 제출 시작 날짜 (UTC+0)
updated_at	제출 데이터 업데이트 날짜 (UTC+0)
kyb_status	KYB 제출 상태 {Open, Complete, Closed} - Open: 필요 서류를 수집 중이거나 검수 중에 있음 - Complete: 처리가 완료됨 - Closed: 서류 요청에 응답이 없어 일시 중단됨
aml_screen	법인을 기준으로한 AML결과 {Red Flag, Not Screened}
nationality	법인 설립 국가
address	법인 본사 주소
representative	제출 대리인에 대한 신원정보 데이터 오브젝트
representative.nationality	제출 대리인의 국적
representative.name	제출 대리인의 이름
representative.status	대표 또는 제출 대리인의 정보 제출 상태 {Open / Complete} - Open: 신원 확인에 필요한 서류를 수집하거나 검토 중임 - Complete: 서류 수집과 검토가 완료됨
representative.represent_type	제출자 유형 (null, ceo, delegate) - null: 알 수 없음 - ceo: 대표이사 - delegate: 제출 대리인
representative.date_of_birth	제출 대리인의 생년월일
representative.ceo_name	대표자 이름
AML	법인에 대한 AML 결과 오브젝트
AML.matches	AML 매칭 결과 오브젝트
AML.matches.score	AML 결과 매칭된 법인의 유사도
AML.matches.resource_id	AML 결과 매칭된 법인의 고유 ID
AML.match_count	AML 스크리닝 결과 매칭 건수
aml_result	법인에 대한 AML 결과 오브젝트
aml_result.risk_level	AML 매칭된 법인의 위험도 {HIGH, MEDIUM, LOW}
aml_risk_level_summary	AML 매칭된 법인의 위험도 종합결과
directors	이사의 정보 오브젝트
directors.name	이사의 이름
directors.status	이사의 신원정보 제출 상태 {Open, Complete} - Open: 제출이 완료되어 검수 중에 있음 - Complete: 제출이 정상적으로 완료 됨
directors.date_of_birth	이사의 생년월일
directors.nationality	이사의 국적
directors.created_at	이사의 신원정보가 제출된 날짜 (UTC+0)
directors.updated_at	이사의 신원정보가 업데이트된 날짜 (UTC+0)
directors.AML	이사의 AML 스크리닝 결과 오브젝트
directors.AML.matches	이사의 AML 매칭 결과 오브젝트
directors.AML.matches.score	AML 대상 이사에 매칭된 감시 목록의 유사도
directors.AML.matches.resourceId	AML 대상 이사에 매칭된 감시 목록의 고유 아이디
directors.AML.match_count	AML 대상 이사와 매칭된 감시 목록의 총 개수
directors.aml_result	AML 대상 이사와 매칭된 감시 목록의 최종 결과 오브젝트
directors.aml_update_time	AML 대상 이사와 매칭된 감시 목록에 대한 최종 결과 업데이트 날짜 (UTC+0)
directors.aml_screen	이사를 기준으로한 AML결과 {Red Flag, Not Screened}
directors.aml_result.risk_level	AML 대상 이사와 매칭된 감시 목록에 대한 위험도 {HIGH, MEDIUM, LOW}
directors.aml_risk_level_summary	AML 대상 이사에 대한 위험도 종합 결과
shareholders	주주의 정보 오브젝트
shareholders.name	주주의 이름
shareholders.status	주주의 신원정보 제출 상태 {Open, Complete} - Open: 서류를 수집 중이거나 검수 중에 있음 - Complete: 제출이 정상적으로 완료 되었음
shareholders.type	주주의 유형 {Individual, Corporate} - Individual: 개인 - Corporate: 법인
shareholders.nationality	주주의 국적
shareholders.ratio	지분 소유 비율 (%)
shareholders.date_of_birth	주주의 생년월일
shareholders.created_at	주주의 신원정보 제출 날짜 (UTC+0)
shareholders.updated_at	주주의 신원정보 업데이트 날짜 (UTC+0)
shareholders.parent	주주의 모회사 “ “ : 본인 소유의 법인 경우 공란으로 표시 됨. UBOName: 모회사가 있을 경우 이름이 표시 됨.
shareholders.level	실 소유 단계
shareholders.aml_screen	주주를 기준으로한 AML결과 {Red Flag, Not Screened}
shareholders.AML	AML 대상 주주에 대한 스크리닝 결과 오브젝트
shareholders.AML.matches	AML 대상 주주에 대한 매칭 결과 오브젝트
shareholders.AML.matches.score	AML 대상 주주에 매칭된 감시 목록의 유사도
shareholders.AML.matches.resourceId	AML 대상 주주에 매칭된 감시 목록의 고유 아이디
shareholders.AML.match_count	AML 대상 주주와 매칭된 감시 목록의 총 개수
shareholders.aml_result	AML 대상 주주와 매칭된 감시 목록의 최종 결과 오브젝트
shareholders.aml_result.risk_level	AML 대상 주주와 매칭된 감시 목록에 대한 위험도 {HIGH, MEDIUM, LOW}
note	제출된 KYB 데이터에 대한 메모 오브젝트
note.title	메모 제목
note.text	메모 작성 내용
note.user	메모 작성자의 이메일
note.update_at	메모 최종 업데이트 날짜
aml_final_status	법인, 대리인, 임원, 주주를 모두 종합한 최종 결과 {Red Flag, Not Screened}
aml_final_update_time	AML 최종 결과 업데이트 날짜 (UTC+0)
nextpageKey	추가로 출력될 다음 페이지가 있을 경우에 전달되는 키 값 오브젝트
nextpageKey.id	다음 페이지 호출시 필요한 가장 마지막으로 조회되었던 submission의 id 값
nextpageKey.created_at	다음 페이지 호출시 필요한 가장 마지막으로 조회되었던 submission의 created_at 값 (UTC + 0)

Sample

Submission ID로 단 건 조회하기

Sample Request

• 제출 완료된 KYB의 데이터(submission)를 조회하기 위한 샘플 요청 값 입니다.

• 반드시 Query Params로 조회해야 하며, URL과 x-api-key 를 반드시 입력해 주어야 합니다.

• 단 건만 조회가 가능합니다.

curl --location 'https://n7k6pdugib.execute-api.us-east-1.amazonaws.com/dev/kybsubmission?submission_id={submission_id}'\
--header 'x-api-key: {yourAPIKey}'

Sample Response

• KYB 데이터(submission) 조회 샘플 데이터입니다.

• 대표이사 또는 제출 대리인의 신원 정보 데이터, 이사진 정보, 주주 정보, AML 결과 등을 확인할 수 있습니다.

[
    {
        "projectId": "{projectId}",
        "representative": {
            "nationality": "South Africa",
            "name": "{name}",
            "status": "complete",
            "date_of_birth": "{YYYY-MM-DD}",
            "ceo_name": "{ceo_name}",
            "represent_type": "ceo"
        },
        "address": "{address}",
        "directors": [
            {
                "nationality": "South Africa",
                "name": "{name}",
                "status": "complete",
                "date_of_birth": "{YYYY-MM-DD}",
                "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "aml_screen": "Not Screened"
            },
            {
                "AML": {
                    "matches": [
                        {
                            "score": 98,
                            "resourceId": "{resourceId}"
                        },
                        {
                            "score": 98,
                            "resourceId": "{resourceId}"
                        },
                        {
                            "score": 94,
                            "resourceId": "{resourceId}"
                        }
                    ],
                    "match_count": 3
                },
                "nationality": "Ireland",
                "name": "{name}",
                "status": "complete",
                "date_of_birth": "{YYYY-MM-DD}",
                "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "aml_risk_level_summary": "HIGH",
                "aml_screen": "Red Flag",
                "aml_result": [
                    {
                        "risk_level": "HIGH"
                    },
                    {
                        "risk_level": "LOW"
                    },
                    {
                        "risk_level": "HIGH"
                    }
                ]
            }
        ],
        "note": [
            {
                "text": "{text}",
                "title": "{title}",
                "user": "{user}",
                "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}"
            }
        ],
        "aml_screen": "Red Flag",
        "AML": {
            "matches": [
                {
                    "score": 70,
                    "resource_id": "{resourceId}"
                },
                {
                    "score": 66,
                    "resource_id": "{resourceId}"
                }
            ],
            "match_count": 2
        },
        "submissionId": "1lewambih",
        "nationality": "South Africa",
        "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "aml_result": [
            {
                "risk_level": "LOW"
            },
            {
                "risk_level": "LOW"
            }
        ],
        "aml_risk_level_summary": "LOW",
        "kyb_status": "complete",
        "aml_final_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "company_name": "{company_name}",
        "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "aml_final_status": "Red Flag",
        "shareholders": [
            {
                "nationality": "India",
                "ratio": 15,
                "amlScreen": "Red Flag",
                "AML": {
                    "matches": [
                        {
                            "score": 98,
                            "resourceId": "{resourceId}"
                        },
                        {
                            "score": 98,
                            "resourceId": "{resourceId}"
                        },
                        {
                            "score": 94,
                            "resourceId": "{resourceId}"
                        }
                    ],
                    "match_count": 3
                },
                "date_of_birth": "{YYYY-MM-DD}",
                "status": "complete",
                "type": "individual",
                "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
                "parent": "0000",
                "level": 1,
                "name": "Harish Chandra",
                "aml_result": [
                    {
                        "risk_level": "HIGH"
                    },
                    {
                        "risk_level": "HIGH"
                    },
                    {
                        "risk_level": "MEDIUM"
                    }
                ]
            }
        ]
    }
]

List로 여러 건 조회하기

Sample Request

• 제출 완료된 KYB의 데이터(submission)를 조회하기 위한 샘플 요청 값 입니다.

• 반드시 Query Params로 조회해야 하며, URL과 x-api-key 를 반드시 입력해 주어야 합니다.

• 제출된 모든 KYC데이터(submission)가 조회 됩니다.

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

Sample Response

• KYB 데이터(submission) 조회 샘플 데이터입니다.

• KYC 신원 정보 데이터, KYC 결과, 거절 사유 및 코드 등을 확인 할 수 있습니다.

[
    {
        "projectId": "{projectId}",
        "representative": {
            "nationality": "South Korea",
            "name": "{name}",
            "status": "complete",
            "date_of_birth": "{YYYY-MM-DD}",
            "ceo_name": "{ceo_name}",
            "represent_type": "ceo"
        },
        "address": "KOR",
        "aml_screen": "Not Screened",
        "submissionId": "{submissionId}",
        "nationality": "South Korea",
        "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "kyb_status": "complete",
        "aml_final_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "company_name": "{company_name}",
        "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}"
    },
    {
        "projectId": "19ae0127180a8828871609a46fca8186",
        "representative": {
            "nationality": "South Korea",
            "name": "{name}",
            "status": "complete",
            "date_of_birth": "{YYYY-MM-DD}",
            "ceo_name": "{ceo_name}",
            "represent_type": "ceo"
        },
        "address": "KOR",
        "aml_screen": "Not Screened",
        "submissionId": "{submissionId}",
        "nationality": "South Korea",
        "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "kyb_status": "complete",
        "aml_final_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "company_name": "{company_name}",
        "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}"
    },
    {
        "projectId": "{projectId}",
        "representative": {
            "nationality": "South Korea",
            "name": "{name}",
            "status": "complete",
            "date_of_birth": "{YYYY-MM-DD}",
            "ceo_name": "{ceo_name}",
            "represent_type": "null"
        },
        "address": "KOR, Seoul",
        "aml_screen": "Not Screened",
        "submissionId": "{submissionId}",
        "nationality": "South Korea",
        "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "kyb_status": "complete",
        "aml_final_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "company_name": "{company_name}",
        "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}"
    },
    {
        "projectId": "{projectId}",
        "representative": {
            "nationality": "South Korea",
            "name": "{name}",
            "status": "complete",
            "date_of_birth": "{YYYY-MM-DD}",
            "ceo_name": "{ceo_name}",
            "represent_type": "ceo"
        },
        "address": "KOR",
        "aml_screen": "Not Screened",
        "submissionId": "{submissionId}",
        "nationality": "South Korea",
        "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "kyb_status": "complete",
        "aml_final_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "company_name": "{company_name}",
        "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}"
    },
    {
        "projectId": "{projectId}",
        "representative": {
            "nationality": "South Africa",
            "name": "{name}",
            "status": "complete",
            "date_of_birth": "{YYYY-MM-DD}",
            "ceo_name": "{ceo_name}",
            "represent_type": "ceo"
        },
        "address": "South Africa",
        "aml_screen": "Red Flag",
        "submissionId": "{submissionId}",
        "nationality": "South Africa",
        "created_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "updated_at": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "aml_risk_level_summary": "LOW",
        "kyb_status": "complete",
        "aml_final_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}",
        "company_name": "{company_name}",
        "aml_update_time": "{YYYY-MM-DD-HH-MM-SS-ZZZ}"
    }
]