ID 분석기(미리 보기)
ID 분석기는 여러 가지 ID 확인 제품을 제공합니다. 애플리케이션에 가장 적합한 솔루션을 선택하려면 각 제품에 대한 기본 지식을 습득해야 합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | ID 분석기 지원 |
| URL | https://www.idanalyzer.com/contact.html |
| 전자 메일 | support@idanalyzer.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Evith Techology |
| 웹 사이트 | https://www.idanalyzer.com/ |
| 개인 정보 보호 정책 | https://www.idanalyzer.com/privacy-policy.html |
| 카테고리 | IT 작업; 생산력 |
ID 분석기 플랫폼은 기업, 조직 및 개인에게 국경 없이 작동하는 진정한 글로벌 ID 확인 솔루션, 특정 요구 및 요구에 맞게 조정할 수 있는 솔루션 및 지속적으로 업그레이드되고 개선되는 보안 시스템을 제공합니다.
전 세계 190개 이상의 국가에서 4,000개 이상의 다양한 ID 형식에서 전체 ID 확인 액세스 및 정보를 제공하는 이 솔루션은 현대 세계를 염두에 두고 설계된 글로벌 솔루션입니다.
필수 조건
- ID 분석기가 있는 개발자 계정입니다. 등록 시 체험 계정에 등록할 수 있습니다 .
- 계정에 등록하면 ID 분석기 웹 포털에서 API 키가 제공됩니다. 이 API 키를 사용하여 커넥터 인증
자격 증명을 가져오는 방법
- 등록으로 이동
- 필요한 정보를 입력합니다.
- 이렇게 하라는 메시지가 표시되면 전자 메일을 확인합니다.
- 계정 세부 정보가 포함된 ID 분석기 웹 포털 에 새 API 키가 표시됩니다. 나중에 사용할 수 있도록 "복사" 단추를 눌러 클립보드에 저장합니다.
자주 묻는 질문(FAQ)
고객의 개인 정보 보호가 걱정됩니다. API에서 고객에 대한 정보를 저장하나요?
모든 항목은 클라이언트의 자격 증명 모음에만 저장되며 임의로 유출되지 않습니다. 다른 위치에는 복사본이 없습니다.
"크레딧"은 무엇인가요? API 크레딧을 어떻게 구매할 수 있나요?
계정에 대한 남은 선불 크레딧입니다. 월별 플랜이 있는 경우 선불 크레딧 전에 월별 할당량이 사용됩니다.
문서가 진짜인지 가짜인지 확인하려면 어떻게 해야 하나요?
인증을 켜면 결과에 인증 점수가 포함됩니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| API API 키 | 시큐어스트링 (보안 문자열) | 이 API의 API 키 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| AML 데이터베이스 검색 |
AML API를 사용하면 ID 분석기 글로벌 AML 데이터베이스에서 이름, 문서 번호 또는 둘 다를 사용하여 제재, PEP 및 원하는 범죄자를 검색할 수 있습니다. 생일 및 국적을 사용하여 결과를 추가로 필터링할 수 있습니다. |
|
Docu |
사용자가 ID 확인 없이 법적 문서를 검토하고 전자 서명하는 서명 세션을 만들 수 있습니다. ID 확인을 모두 수행하고 사용자가 일부 문서에 서명하도록 하려면 대신 ID 확인 세션을 만드세요. |
|
Docu |
ID 확인이 필요한 모든 사용자에 대한 확인 세션을 만들 수 있습니다. |
| Face Search 교육 |
얼굴 검색을 수행하기 전에 자격 증명 모음 내에서 문서 데이터 세트를 학습하는 학습 명령을 실행해야 합니다. 웹 포털을 통해 자격 증명 모음 데이터를 학습시킬 수도 있습니다. 학습 작업은 비동기적이며 학습 시간은 자격 증명 모음 항목 및 이미지의 수에 따라 달라집니다. 몇 초에서 1시간 정도 걸릴 수 있습니다. |
| 얼굴 검색 |
얼굴 검색을 사용하면 사용자의 이미지를 사용하여 전체 자격 증명 모음을 검색할 수 있습니다. 얼굴 검색 기능을 사용하려면 웹 포털에서 얼굴 검색 인덱싱을 사용하도록 설정하고 자격 증명 모음 데이터 세트를 주기적으로 학습해야 합니다. |
| 자격 증명 모음 항목 업데이트 |
HTTP POST 요청을 통해 자격 증명 모음 항목에서 단일 필드 또는 여러 필드의 값을 업데이트할 수 있습니다. |
| 자격 증명 모음 항목 콘텐츠 가져오기 |
항목이 자격 증명 모음에 추가되면 Core API와 DocuPass API 모두 자격 증명 모음이라는 자격 증명 모음 항목 식별자를 반환합니다. 다음 엔드포인트에 HTTP POST 요청을 제출하여 식별자를 사용하여 자격 증명 모음에 있는 항목의 콘텐츠를 쿼리할 수 있습니다. |
| 자격 증명 모음에 이미지 추가 |
HTTP POST 요청을 만들어 이미지를 업로드하고 기존 자격 증명 모음 항목에 추가할 수 있습니다. |
| 자격 증명 모음에서 이미지 삭제 |
HTTP POST 요청을 통해 자격 증명 모음 항목 내의 이미지를 삭제할 수 있습니다. 이미지를 삭제한 후에도 캐싱으로 인해 짧은 시간 동안 이미지의 URL에 계속 액세스할 수 있습니다. |
| 자격 증명 모음에서 항목 삭제 |
HTTP POST 요청을 통해 단일 또는 여러 자격 증명 모음 항목을 삭제할 수 있습니다. |
| 콜백 유효성 검사 |
서버에서 데이터를 보냈는지 확인합니다. |
| 학습 상태 |
자격 증명 모음 학습이 아직 진행 중인지 또는 완료되었는지 확인합니다. |
| 항목 나열 및 필터링 |
자격 증명 모음 내에 저장된 모든 항목을 나열하거나 특정 값이 있는 항목을 검색하려면 다음 엔드포인트에 HTTP POST 요청을 보냅니다. |
| 핵심 API 설정 |
원격 물리적 문서, 해당 신뢰성 및 얼굴을 확인하는 다기능 ID 확인 API는 문서와 사용자 사진과 일치합니다. |
AML 데이터베이스 검색
AML API를 사용하면 ID 분석기 글로벌 AML 데이터베이스에서 이름, 문서 번호 또는 둘 다를 사용하여 제재, PEP 및 원하는 범죄자를 검색할 수 있습니다. 생일 및 국적을 사용하여 결과를 추가로 필터링할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
이름
|
name | string |
모든 언어의 개인 또는 조직의 이름 또는 별칭입니다. |
|
|
documentnumber
|
documentnumber | string |
사람의 여권 번호, 국가 ID 번호 또는 운전 면허증 번호 등 |
|
|
개체
|
entity | string |
person: Person; 적법성: 회사 또는 조직 |
|
|
country
|
country | string |
국가/국적이 일치하거나 국가 정보가 없는 엔터티만 반환합니다. |
|
|
생년월일
|
dob | string |
일치하는 생일 또는 생일 정보가 없는 엔터티만 반환합니다. |
|
|
데이터베이스
|
database | string |
AML 검사를 수행할 원본 데이터베이스를 지정합니다. 비워 두면 모든 원본 데이터베이스가 선택됩니다. 각 데이터베이스 코드를 쉼표(예: un_sc,us_ofac)로 구분합니다. 원본 데이터베이스 및 해당 코드의 전체 목록은 AML API 개요를 참조하세요. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
aml
|
items | array of object |
AML 일치 목록을 포함하는 배열은 일치하는 항목이 없으면 빈 배열을 반환합니다. 자세한 내용은 AML API 참조를 참조하세요. |
|
개체
|
items.entity | string |
개인 또는 적법성 |
|
fullname
|
items.fullname | array of string |
개인 또는 법인 이름 |
|
이름
|
items.firstname | array of string |
개인 이름 |
|
lastname
|
items.lastname | array of string |
사람 성 |
|
middlename
|
items.middlename | array of string |
사람 중간 이름 |
|
별명
|
items.alias | array of string |
엔터티의 대체 또는 외신 이름 |
|
생년월일
|
items.dob | array of string |
페론의 생일은 YYYY, YYYY-MM 또는 YYYY-MM-DD 형식으로 올 수 있습니다. |
|
address
|
items.address | array of string |
엔터티의 주소 또는 거주 국가 |
|
국적
|
items.nationality | array of string |
엔터티의 국가 또는 국적 |
|
출생지
|
items.birthplace | array of string |
페론의 출생지 |
|
gender
|
items.gender | array of string |
페론의 성별: M 또는 F |
|
documentnumber
|
items.documentnumber | array of object |
엔터티와 연결된 문서 목록입니다. |
|
아이디
|
items.documentnumber.id | string |
문서 번호 |
|
id_formatted
|
items.documentnumber.id_formatted | string |
영숫자 문서 번호 |
|
country
|
items.documentnumber.country | string |
ISO2 국가 코드 |
|
type
|
items.documentnumber.type | string |
P = Passport 번호, I = ID 번호, D = 운전 면허증 번호, O = 기타/알 수 없는 문서 유형 |
|
프로그램
|
items.program | array of string |
제재 프로그램 |
|
메모
|
items.note | array of string |
엔터티에 대한 추가 참고 사항 |
|
time
|
items.time | string |
엔터티가 원본 목록에 추가되었거나 마지막으로 업데이트된 경우 UTC TZ 타임스탬프 |
|
status
|
items.status | string |
제재 대상의 엔터티 또는 현재 상태의 위치/제목 |
|
source
|
items.source | array of string |
공식 원본 URL 목록 |
|
데이터베이스
|
items.database | string |
ID 분석기 AML 데이터베이스 코드 |
|
schema(스키마)
|
items.schema | string |
DocuPass 서명 세션 만들기
사용자가 ID 확인 없이 법적 문서를 검토하고 전자 서명하는 서명 세션을 만들 수 있습니다. ID 확인을 모두 수행하고 사용자가 일부 문서에 서명하도록 하려면 대신 ID 확인 세션을 만드세요.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
companyname
|
companyname | True | string |
최종 사용자가 회사에 ID 정보를 제출하고 있음을 알 수 있도록 회사 이름이 확인 페이지 전체에 표시됩니다. |
|
템플릿_아이디
|
template_id | string |
사용자 데이터로 자동 채우기를 위한 계약 템플릿 ID입니다. |
|
|
contract_format
|
contract_format | string |
출력 문서 형식입니다. (PDF, DOCX, HTML) |
|
|
callbackurl
|
callbackurl | string |
계약 파일이 이 URL로 전송됩니다. 생성된 문서를 저장할 수 있도록 vault_save 사용하도록 설정하거나 콜백러를 지정해야 합니다. |
|
|
successredir
|
successredir | string |
문서를 검토하고 서명한 후 브라우저가 이 URL로 리디렉션됩니다. DocuPass 참조 코드 및 customid가 URL 끝에 추가됩니다. |
|
|
customid
|
customid | string |
서버의 콜백 URL로 다시 전송되고 successredir 및 failredir에서 설정한 리디렉션 URL에 쿼리 문자열로 추가되는 사용자 지정 문자열입니다. 데이터베이스 내에서 사용자를 식별하는 데 유용합니다. 이 값은 자격 증명 모음 아래의 docupass_customid 아래에 저장됩니다. |
|
|
재사용할 수 있는
|
reusable | boolean |
이 매개 변수를 사용하면 여러 사용자가 동일한 URL을 통해 문서를 검토하고 서명할 수 있습니다. 각 사용자에 대해 새 DocuPass 참조 코드가 자동으로 생성됩니다. |
|
|
sms_contract_link
|
sms_contract_link | string |
전체 국가별 휴대폰 번호 |
|
|
vault_save
|
vault_save | boolean |
생성된 문서를 자격 증명 모음에 저장합니다. 생성된 문서를 저장할 수 있도록 vault_save 사용하거나 콜백러를 지정해야 합니다. |
|
|
노브랜드
|
nobranding | boolean |
모든 DocuPass 페이지에서 브랜딩 로고를 숨깁니다. |
|
|
customhtmlurl
|
customhtmlurl | string |
사용자 고유의 HTML 페이지와 DocuPass용 CSS를 사용합니다. HTML 및 CSS를 변경한 후에는 사용자 고유의 서버에 업로드해야 합니다. 각 세션이 시작될 때 DocuPass는 서버에서 최신 HTML 페이지를 다운로드합니다. |
|
|
language
|
language | string |
DocuPass는 자동으로 사용자 디바이스 언어를 검색하고 해당 언어를 표시합니다. 자동 언어 검색을 재정의하려면 이 매개 변수를 설정합니다. (en, fr, nl, de, es, zh-TW, zh-CN) |
|
|
만료
|
expiry | integer |
DocuPass 세션이 만료되기 전의 시간(초)입니다. 만료되면 사용자는 현재 세션을 계속할 수 없으므로 실패한 콜백도 전송됩니다. |
|
|
qr_color
|
qr_color | string |
QR 코드 전경 색 |
|
|
qr_bgcolor
|
qr_bgcolor | string |
QR 코드 배경 색 |
|
|
qr_size
|
qr_size | integer |
QR 코드의 크기 |
|
|
qr_margin
|
qr_margin | integer |
QR 코드의 테두리 두께 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
참조
|
reference | string |
DocuPass 세션에 대한 고유 참조 코드입니다. |
|
customid
|
customid | string |
DocuPass 세션을 만들 때 사용되는 사용자 지정 ID입니다. |
|
url
|
url | string |
DocuPass 웹앱에 대한 고유 URL입니다. 이 링크를 사용자에게 보내거나 웹 사이트 또는 모바일 앱에 포함하여 문서를 검토하고 서명합니다. |
|
qrcode
|
qrcode | string |
사용자가 검색할 QR 코드 이미지 URL |
|
base_url
|
base_url | string |
이 링크를 사용자에게 보내고 참조 코드를 입력하여 문서에 서명하도록 요청할 수 있습니다. |
|
html_qrcode
|
html_qrcode | string |
웹 페이지에 QR 코드를 표시하는 샘플 HTML입니다. |
|
html_iframe
|
html_iframe | string |
웹 페이지에 iframe을 삽입하는 샘플 HTML입니다. |
|
smssent
|
smssent | string |
SMS가 sms_contract_link 매개 변수를 통해 성공적으로 전송되었을 때의 확인으로 전화 번호를 포함합니다. |
|
만료
|
expiry | integer |
이 세션이 만료되는 시기를 나타내는 UTC UNIX 타임스탬프는 만료 시 사용자가 더 이상 링크를 사용할 수 없으며 실패한 콜백이 전송됩니다. |
DocuPass 세션 만들기
ID 확인이 필요한 모든 사용자에 대한 확인 세션을 만들 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
type
|
type | integer |
0: Iframe 모듈 ,1: 모바일 모듈, 2: 리디렉션 모듈, 3: 라이브 모바일 모듈 |
|
|
companyname
|
companyname | True | string |
회사 또는 제품 이름입니다. |
|
callbackurl
|
callbackurl | string |
확인 결과를 받을 웹후크/콜백 URL입니다. |
|
|
생체 인식
|
biometric | integer |
사용자에게 얼굴 확인을 위해 셀카 사진 또는 셀카 비디오를 찍도록 요청합니다. |
|
|
biometric_threshold
|
biometric_threshold | float |
얼굴 생체 인식 확인을 통과하기 위한 최소 점수 지정 |
|
|
authenticate_minscore
|
authenticate_minscore | float |
유효성 검사를 통과하려면 문서가 최소 신뢰성 점수를 충족해야 합니다. 유효성/신뢰성 검사를 사용하지 않도록 설정하려면 0을 설정합니다. |
|
|
authenticate_module
|
authenticate_module | integer |
문서의 유효성을 검사하는 데 사용되는 모듈을 지정합니다. |
|
|
maxattempt
|
maxattempt | integer |
각 확인 요청에 대한 최대 실패 시도 횟수입니다. |
|
|
successredir
|
successredir | string |
ID 확인에 성공하면 브라우저가 이 URL로 리디렉션됩니다. |
|
|
failredir
|
failredir | string |
ID 확인에 실패하면 브라우저가 이 URL로 리디렉션됩니다. |
|
|
customid
|
customid | string |
데이터베이스 내에서 사용자를 식별하는 데 유용합니다. 이 값은 자격 증명 모음 아래의 docupass_customid 아래에 저장됩니다. |
|
|
재사용할 수 있는
|
reusable | boolean |
이 매개 변수를 사용하면 여러 사용자가 동일한 URL을 통해 ID를 확인할 수 있으며 각 사용자에 대해 새 DocuPass 참조 코드가 자동으로 생성됩니다. |
|
|
phoneverification
|
phoneverification | boolean |
사용자에게 확인을 위해 전화 번호를 입력하도록 요청하든 관계없이 DocuPass는 모바일 또는 유선 번호 확인을 모두 지원합니다. (구독자만 해당) |
|
|
documenttype
|
documenttype | string |
사용자는 특정 유형의 문서를 업로드해야 합니다. 예를 들어 "PD"는 여권 및 운전 면허증을 모두 수락합니다. |
|
|
documentcountry
|
documentcountry | string |
ISO ALPHA-2 국가 코드입니다. |
|
|
documentregion
|
documentregion | string |
주/지역 전체 이름 또는 약어입니다. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
이중 측면 검색을 수행할 때 이름, 문서 번호 및 문서 형식이 문서의 앞면과 뒷면 간에 일치하는지 확인합니다. 정보가 불일치하는 경우 오류 14가 throw됩니다. |
|
|
verify_expiry
|
verify_expiry | boolean |
만료되지 않은 문서만 수락합니다. |
|
|
verify_documentno
|
verify_documentno | string |
확인이 필요한 문서 번호입니다. |
|
|
verify_name
|
verify_name | string |
확인이 필요한 이름 및 성을 포함한 전체 이름입니다. |
|
|
verify_dob
|
verify_dob | string |
확인이 필요한 생년월일(YYYY/MM/DD 형식) |
|
|
verify_age
|
verify_age | string |
연령 범위, 예: 18-40 |
|
|
verify_address
|
verify_address | string |
확인이 필요한 전체 주소입니다. |
|
|
verify_postcode
|
verify_postcode | string |
확인이 필요한 전체 우편 번호입니다. |
|
|
verify_phone
|
verify_phone | string |
확인이 필요한 전체 전화 번호입니다. |
|
|
vault_save
|
vault_save | boolean |
사용자 문서 및 구문 분석된 정보를 자격 증명 모음에 저장합니다. |
|
|
return_documentimage
|
return_documentimage | boolean |
콜백 요청에서 사용자가 업로드한 문서 이미지를 반환합니다. |
|
|
return_faceimage
|
return_faceimage | boolean |
콜백 요청에서 사용자가 업로드한 얼굴 이미지를 반환합니다. |
|
|
return_type
|
return_type | integer |
반환되는 이미지 유형(base64로 인코딩된 이미지 콘텐츠 또는 이미지의 URL)을 지정합니다. (이미지에 대한 URL은 7일 동안만 유지됨) |
|
|
welcomemessage
|
welcomemessage | string |
첫 번째 페이지의 일반 인사말 메시지를 사용자 지정 텍스트(최대 1,000자)로 바꿉니다. |
|
|
노브랜드
|
nobranding | boolean |
모든 DocuPass 페이지에서 브랜딩 로고를 숨깁니다. (구독자만 해당) |
|
|
로고
|
logo | string |
사용자 지정 브랜딩 로고. (구독자만 해당) |
|
|
customhtmlurl
|
customhtmlurl | string |
사용자 고유의 HTML 페이지와 DocuPass용 CSS를 사용합니다. (구독자만 해당) |
|
|
language
|
language | string |
DocuPass는 자동으로 사용자 디바이스 언어를 검색하고 해당 언어를 표시합니다. |
|
|
만료
|
expiry | integer |
DocuPass 세션이 만료되기 전의 시간(초)입니다. 만료되면 사용자는 현재 세션을 계속할 수 없으므로 실패한 콜백도 전송됩니다. |
|
|
qr_color
|
qr_color | string |
QR 코드 전경의 색입니다. (Live Mobile 및 Standard Mobile에만 해당) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
QR 코드 배경의 색입니다. (Live Mobile 및 Standard Mobile에만 해당) |
|
|
qr_size
|
qr_size | integer |
QR 코드 크기(1-50)입니다. (Live Mobile 및 Standard Mobile에만 해당) |
|
|
qr_margin
|
qr_margin | integer |
QR Code(1-50)의 테두리 두께입니다. (Live Mobile 및 Standard Mobile에만 해당) |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
참조
|
reference | string |
DocuPass 세션에 대한 고유 참조 코드입니다. |
|
type
|
type | integer |
DocuPass 모듈 형식을 만들었습니다. |
|
customid
|
customid | string |
DocuPass 세션을 만들 때 사용되는 사용자 지정 ID입니다. |
|
url
|
url | string |
DocuPass 웹앱에 대한 고유 URL입니다. 사용자에게 이 링크를 보내거나 웹 사이트 또는 모바일 앱에 포함하여 ID 확인을 시작합니다. |
|
qrcode
|
qrcode | string |
사용자가 검색할 QR 코드 이미지 URL |
|
base_url
|
base_url | string |
이 링크를 사용자에게 보내고 확인을 시작하기 위해 참조 코드를 입력하도록 요청할 수 있습니다. |
|
html
|
html | string |
웹 페이지에 삽입할 수 있는 샘플 HTML입니다. |
|
smssent
|
smssent | integer |
SMS가 sms_verification_link 매개 변수를 통해 성공적으로 전송된 경우 전화 번호를 확인으로 포함합니다. |
|
만료
|
expiry | integer |
이 세션이 만료되는 시기를 나타내는 UTC UNIX 타임스탬프는 만료 시 사용자가 더 이상 링크를 사용할 수 없으며 실패한 콜백이 전송됩니다. |
Face Search 교육
얼굴 검색을 수행하기 전에 자격 증명 모음 내에서 문서 데이터 세트를 학습하는 학습 명령을 실행해야 합니다. 웹 포털을 통해 자격 증명 모음 데이터를 학습시킬 수도 있습니다. 학습 작업은 비동기적이며 학습 시간은 자격 증명 모음 항목 및 이미지의 수에 따라 달라집니다. 몇 초에서 1시간 정도 걸릴 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | integer |
얼굴 검색
얼굴 검색을 사용하면 사용자의 이미지를 사용하여 전체 자격 증명 모음을 검색할 수 있습니다. 얼굴 검색 기능을 사용하려면 웹 포털에서 얼굴 검색 인덱싱을 사용하도록 설정하고 자격 증명 모음 데이터 세트를 주기적으로 학습해야 합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
image
|
image | string |
Base64로 인코딩된 이미지 데이터입니다. |
|
|
imageurl
|
imageurl | string |
원격 이미지 URL입니다. |
|
|
maxentry
|
maxentry | integer |
반환할 일치 항목 수(1에서 10 사이)입니다. |
|
|
문지방
|
threshold | float |
0에서 1까지의 범위에서 필요한 최소 얼굴 유사성 점수를 설정합니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
items
|
items | array of |
일치하는 항목을 찾은 경우 전체 내용이 있는 문서 목록이 목록 명령과 유사하게 반환됩니다. |
자격 증명 모음 항목 업데이트
HTTP POST 요청을 통해 자격 증명 모음 항목에서 단일 필드 또는 여러 필드의 값을 업데이트할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
아이디
|
id | True | string |
자격 증명 모음 항목 식별자입니다. |
|
주소1
|
address1 | string |
주소 줄 1. |
|
|
주소2
|
address2 | string |
주소 줄 2. |
|
|
block
|
block | string |
동일한 문서가 Core API 또는 DocuPass에 제출되지 않도록 하려면 이 매개 변수를 설정합니다. 0: 블록 없음 1: 문서 번호 2 차단: 블록 이름/성 3: 문서 번호와 이름/성 모두 차단 |
|
|
customdata1
|
customdata1 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열입니다. |
|
|
customdata2
|
customdata2 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열입니다. |
|
|
customdata3
|
customdata3 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열입니다. |
|
|
customdata4
|
customdata4 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열입니다. |
|
|
customdata5
|
customdata5 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열입니다. |
|
|
생년월일
|
dob | string |
생년월일(YYYY-MM-DD). |
|
|
문서 이름
|
documentName | string |
문서의 이름입니다. |
|
|
documentNumber
|
documentNumber | string |
문서의 고유 식별자(Passport No./Driver License No. 등) |
|
|
documentType
|
documentType | string |
P: Passport D: 운전 면허증 I: ID 카드 V: 비자 R: 레지던스 카드 O: 기타 |
|
|
docupass_customid
|
docupass_customid | string |
DocuPass 확인을 만들 때 전달된 customid입니다. |
|
|
docupass_failedreason
|
docupass_failedreason | string |
DocuPass 확인에 실패한 경우 실패한 이유입니다. |
|
|
docupass_reference
|
docupass_reference | string |
DocuPass 세션에 대한 참조 코드입니다. |
|
|
docupass_success
|
docupass_success | string |
0 또는 1, DocuPass 확인 성공 또는 실패 여부. |
|
|
메일 주소
|
string |
사용자 전자 메일 주소입니다. |
||
|
만료
|
expiry | string |
만료 날짜(YYYY-MM-DD) |
|
|
eyeColor
|
eyeColor | string |
눈 색입니다. |
|
|
이름 (첫 번째 이름)
|
firstName | string |
이름/지정된 이름 |
|
|
firstName_local
|
firstName_local | string |
로컬 언어의 이름입니다. |
|
|
fullName
|
fullName | string |
전체 이름(다른 이름 필드를 업데이트하면 fullName이 업데이트되지 않음) |
|
|
fullName_local
|
fullName_local | string |
로컬 언어의 이름입니다. |
|
|
hairColor
|
hairColor | string |
머리 색입니다. |
|
|
height
|
height | string |
사람의 높이입니다. |
|
|
issueAuthority
|
issueAuthority | string |
문서의 발급 권한입니다. |
|
|
발급
|
issued | string |
발급 날짜(YYYY-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
ISO2에서 발급된 국가 코드를 문서화합니다. 예: 미국 |
|
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
문서 발급자 하위/상태 약어입니다. 예: CA |
|
|
issuerOrg_region_full
|
issuerOrg_region_full | string |
문서 발급자 하위 리소스/상태입니다. 예: 캘리포니아 |
|
|
유선
|
landline | string |
사용자 유선 전화 번호입니다. |
|
|
lastName
|
lastName | string |
성/가족 이름입니다. |
|
|
lastName_local
|
lastName_local | string |
로컬 언어의 성입니다. |
|
|
중간 이름
|
middleName | string |
중간 이름입니다. |
|
|
middleName_local
|
middleName_local | string |
로컬 언어의 중간 이름입니다. |
|
|
mobile
|
mobile | string |
사용자 휴대폰 번호입니다. |
|
|
nationality_iso2
|
nationality_iso2 | string |
ISO2의 문서 소유자 국적 예: 미국 |
|
|
optionalData
|
optionalData | string |
문서에 포함된 추가 지정되지 않은 데이터입니다. |
|
|
optionalData2
|
optionalData2 | string |
문서에 포함된 추가 지정되지 않은 데이터입니다. |
|
|
personalNumber
|
personalNumber | string |
문서의 보조 식별자 번호입니다. |
|
|
placeOfBirth
|
placeOfBirth | string |
출생지. |
|
|
우편 번호
|
postcode | string |
주소 우편 번호입니다. |
|
|
제한
|
restrictions | string |
운전 제한. |
|
|
성
|
sex | string |
M: 남성 F: 여성 X: 지정 되지 않은 |
|
|
trustlevel
|
trustlevel | string |
0: 결정되지 않은 1: 잘못된 문서 2: 의심스러운 3: 인증을 사용하는 경우 이 점수가 자동으로 계산됩니다. |
|
|
trustnote
|
trustnote | string | ||
|
vehicleClass
|
vehicleClass | string |
운전 면허증에 차량의 클래스. |
|
|
무게
|
weight | string |
사람의 무게. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | integer |
자격 증명 모음 항목 콘텐츠 가져오기
항목이 자격 증명 모음에 추가되면 Core API와 DocuPass API 모두 자격 증명 모음이라는 자격 증명 모음 항목 식별자를 반환합니다. 다음 엔드포인트에 HTTP POST 요청을 제출하여 식별자를 사용하여 자격 증명 모음에 있는 항목의 콘텐츠를 쿼리할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
아이디
|
id | string |
자격 증명 모음 항목 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | integer | |
|
아이디
|
data.id | string |
자격 증명 모음 항목 식별자 |
|
createtime
|
data.createtime | string |
UTC에서 항목 만들기 타임스탬프 |
|
updatetime
|
data.updatetime | string |
UTC의 마지막 수정 타임스탬프 |
|
trustlevel
|
data.trustlevel | string |
인증을 사용하도록 설정하면 이 점수가 자동으로 계산됩니다. (0: 결정되지 않음, 1: 잘못된 문서, 2: 의심스러운 문서, 3: 유효) |
|
trustnote
|
data.trustnote | string |
문서 유효성과 관련된 경고입니다. |
|
docupass_reference
|
data.docupass_reference | string |
DocuPass 세션에 대한 참조 코드 |
|
docupass_success
|
data.docupass_success | string |
0 또는 1, DocuPass 확인 성공 또는 실패 여부. |
|
docupass_failedreason
|
data.docupass_failedreason | string |
DocuPass 확인에 실패한 경우 실패한 이유입니다. |
|
docupass_customid
|
data.docupass_customid | string |
DocuPass 확인을 만들 때 전달된 customid입니다. |
|
documentNumber
|
data.documentNumber | string |
문서의 고유 식별자(Passport No./Driver License No. 등) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
기호 없이 documentNumber의 문자열을 자동으로 생성합니다. 이 필드는 결과를 필터링하는 데 유용합니다. |
|
personalNumber
|
data.personalNumber | string |
문서의 보조 식별자 번호 |
|
이름 (첫 번째 이름)
|
data.firstName | string |
이름/지정된 이름 |
|
중간 이름
|
data.middleName | string |
중간 이름 |
|
lastName
|
data.lastName | string |
성/가족 이름 |
|
fullName
|
data.fullName | string |
전체 이름(다른 이름 필드를 업데이트하면 fullName이 업데이트되지 않음) |
|
firstName_local
|
data.firstName_local | string |
로컬 언어의 이름 |
|
middleName_local
|
data.middleName_local | string |
로컬 언어의 중간 이름 |
|
lastName_local
|
data.lastName_local | string |
로컬 언어의 성 |
|
fullName_local
|
data.fullName_local | string |
로컬 언어의 전체 이름 |
|
생년월일
|
data.dob | string |
생년월일 |
|
발급
|
data.issued | string |
문제 날짜 |
|
만료
|
data.expiry | string |
만료 날짜 |
|
성
|
data.sex | string |
M: 남성, F: 여성, X: 지정되지 않음 |
|
height
|
data.height | string |
사람의 높이 |
|
무게
|
data.weight | string |
사람의 무게 |
|
hairColor
|
data.hairColor | string |
모발 색 |
|
eyeColor
|
data.eyeColor | string |
눈 색 |
|
주소1
|
data.address1 | string |
주소 줄 1 |
|
주소2
|
data.address2 | string |
주소 줄 2 |
|
우편 번호
|
data.postcode | string |
주소 우편 번호 |
|
placeOfBirth
|
data.placeOfBirth | string |
출생지 |
|
documentType
|
data.documentType | string |
P: Passport, D: 운전 면허증, I: 신분증, V: 비자, R: 레지던스 카드, O: 기타 |
|
문서 이름
|
data.documentName | string |
문서 이름 |
|
vehicleClass
|
data.vehicleClass | string |
운전 면허증의 차량 클래스 |
|
제한
|
data.restrictions | string |
운전 제한 사항 |
|
승인
|
data.endorsement | string |
운전면허증 인증 |
|
메일 주소
|
data.email | string |
사용자 전자 메일 주소 |
|
mobile
|
data.mobile | string |
사용자 휴대폰 번호 |
|
유선
|
data.landline | string |
사용자 유선 전화 번호 |
|
issueAuthority
|
data.issueAuthority | string |
문서의 발급 권한 |
|
issuerOrg_region_full
|
data.issuerOrg_region_full | string |
문서 발급자 하위 리소스/상태입니다. 예: 캘리포니아 |
|
issuerOrg_region_abbr
|
data.issuerOrg_region_abbr | string |
문서 발급자 하위/상태 약어입니다. 예: CA |
|
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
ISO2에서 발급된 국가 코드를 문서화합니다. 예: 미국 |
|
nationality_iso2
|
data.nationality_iso2 | string |
ISO2의 문서 소유자 국적 예: 미국 |
|
optionalData
|
data.optionalData | string |
문서에 포함된 추가 지정되지 않은 데이터 |
|
optionalData2
|
data.optionalData2 | string |
문서에 포함된 추가 지정되지 않은 데이터 |
|
customdata1
|
data.customdata1 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열 |
|
customdata2
|
data.customdata2 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열 |
|
customdata3
|
data.customdata3 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열 |
|
customdata4
|
data.customdata4 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열 |
|
customdata5
|
data.customdata5 | string |
항목에 사용자 지정 메모를 추가하는 데 사용할 수 있는 5개의 사용자 지정 문자열 |
|
block
|
data.block | string |
동일한 문서가 Core API 또는 DocuPass에 제출되지 않도록 하려면 이 매개 변수를 설정합니다. |
|
계약
|
data.contract | string |
Core API 또는 DocuPass를 사용하여 생성/서명된 계약 또는 법적 문서에 대한 링크 |
|
image
|
data.image | array of object |
항목과 연결된 이미지 목록을 포함합니다. |
|
아이디
|
data.image.id | string |
이미지 식별자 |
|
type
|
data.image.type | string |
문서의 경우 0, 사람 1 |
|
hash
|
data.image.hash | string |
이미지의 MD5 해시 |
|
url
|
data.image.url | string |
이미지에 대한 URL |
|
createtime
|
data.image.createtime | string |
UTC로 업로드된 시간 이미지 |
자격 증명 모음에 이미지 추가
HTTP POST 요청을 만들어 이미지를 업로드하고 기존 자격 증명 모음 항목에 추가할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
아이디
|
id | True | string |
이미지를 추가할 자격 증명 모음 항목 식별자 |
|
type
|
type | True | string |
이미지 유형 설정: 0=문서 및 1=person |
|
image
|
image | string |
Base64로 인코딩된 이미지 데이터입니다. |
|
|
imageurl
|
imageurl | string |
원격 이미지 URL입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | integer | |
|
아이디
|
image.id | string |
이미지 식별자 |
|
type
|
image.type | string |
문서의 경우 0, 사람 1 |
|
hash
|
image.hash | string |
이미지의 MD5 해시 |
|
url
|
image.url | string |
이미지에 대한 URL |
|
createtime
|
image.createtime | string |
UTC로 업로드된 시간 이미지 |
자격 증명 모음에서 이미지 삭제
HTTP POST 요청을 통해 자격 증명 모음 항목 내의 이미지를 삭제할 수 있습니다. 이미지를 삭제한 후에도 캐싱으로 인해 짧은 시간 동안 이미지의 URL에 계속 액세스할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
아이디
|
id | True | string |
이미지를 포함하는 자격 증명 모음 항목 식별자입니다. |
|
imageid
|
imageid | string |
삭제할 이미지의 ID입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | integer |
자격 증명 모음에서 항목 삭제
HTTP POST 요청을 통해 단일 또는 여러 자격 증명 모음 항목을 삭제할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
아이디
|
id | True | array of string |
아이디 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | integer |
콜백 유효성 검사
서버에서 데이터를 보냈는지 확인합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
참조
|
reference | True | string |
POST BODY에서 받은 참조 코드입니다. |
|
hash
|
hash | True | string |
POST BODY에서 받은 해시입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공
|
success | boolean | |
|
참조
|
reference | string |
DocuPass 세션에 대한 참조 코드 |
학습 상태
자격 증명 모음 학습이 아직 진행 중인지 또는 완료되었는지 확인합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
status
|
status | string |
nottrained: 학습되지 않음, 시작되지 않음: 학습이 실행되지 않음, 실행 중: 학습이 현재 실행 중이고, 성공했습니다. 학습 성공, 실패: 학습 실패 |
|
startTime
|
startTime | string |
마지막 학습이 UTC에서 시작된 시간입니다. |
|
statusChangeTime
|
statusChangeTime | string |
마지막 상태 변경 시간(UTC)입니다. |
|
lastSuccessTime
|
lastSuccessTime | string |
UTC에서 마지막으로 성공한 학습을 위한 시간입니다. |
|
오류
|
error | string |
실패한 학습 상태와 관련된 오류 메시지입니다. |
항목 나열 및 필터링
자격 증명 모음 내에 저장된 모든 항목을 나열하거나 특정 값이 있는 항목을 검색하려면 다음 엔드포인트에 HTTP POST 요청을 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
orderby
|
orderby | string |
결과를 정렬하는 데 사용되는 필드의 이름입니다. |
|
|
sort
|
sort | string |
결과를 오름차순으로 정렬하려면 ASC, 내림차순으로 정렬하려면 DESC입니다. |
|
|
limit
|
limit | integer |
반환할 자격 증명 모음 항목의 수입니다. (1~100) |
|
|
offset
|
offset | integer |
특정 항목에서 시작하는 반환 목록(예: limit=10)이 결과의 세 번째 페이지에 액세스하려면 offset=20을 사용합니다. |
|
|
filter
|
filter | array of string |
filter |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
limit
|
limit | integer |
현재 한도 |
|
offset
|
offset | integer |
현재 오프셋 |
|
nextoffset
|
nextoffset | integer |
다음 데이터 집합의 오프셋 값입니다. 현재 데이터 집합이 최종 데이터 집합인 경우 이 필드는 반환되지 않습니다. |
|
합계
|
total | integer |
찾은 총 항목 수입니다. |
|
items
|
items | array of |
GET 메서드에서 반환한 내용과 동일한 항목 배열 및 해당 전체 콘텐츠입니다. |
핵심 API 설정
원격 물리적 문서, 해당 신뢰성 및 얼굴을 확인하는 다기능 ID 확인 API는 문서와 사용자 사진과 일치합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
프라이빗 API 키는 웹 포털에서 사용할 수 있습니다. |
|
file_base64
|
file_base64 | string |
application/x-www-form-urlencoded 또는 application/json을 사용하여 base64로 인코딩된 이미지를 문자열로 업로드할 수 있습니다. |
|
|
url
|
url | string |
코어 API는 서버에서 원격 이미지를 다운로드할 수 있습니다. |
|
|
file_back_base64
|
file_back_base64 | string |
이중 측면 검사를 수행하기 위해 문서 뒷면의 Base64로 인코딩된 이미지입니다. |
|
|
url_back
|
url_back | string |
이중 측면 검사를 수행하기 위한 문서 뒷면의 원격 이미지입니다. |
|
|
face_base64
|
face_base64 | string |
사진 생체 인식 확인을 수행하기 위해 사람의 얼굴의 Base64로 인코딩된 이미지입니다. |
|
|
faceurl
|
faceurl | string |
사진 생체 인식 확인을 수행하기 위해 사람의 얼굴의 원격 이미지입니다. |
|
|
video_base64
|
video_base64 | string |
Base64로 인코딩된 셀카 비디오를 사용하여 비디오 생체 인식 확인을 수행합니다. |
|
|
videourl
|
videourl | string |
원격 호스팅 셀카 비디오를 사용하여 비디오 생체 인식 확인을 수행합니다. |
|
|
암호
|
passcode | string |
4자리 숫자 |
|
|
정확성
|
accuracy | integer |
문서 인식 및 ocr 결과의 속도와 정확도를 구성합니다. 낮은 정확도는 응답 시간을 1초 미만으로 줄이는 반면 높은 정확도는 일반적으로 2~3초가 걸립니다. |
|
|
authenticate
|
authenticate | boolean |
문서의 유효성을 검사하여 문서가 인증되었는지, 변조되지 않았는지 확인합니다. |
|
|
authenticate_module
|
authenticate_module | string |
문서의 유효성을 검사하는 데 사용되는 모듈을 지정합니다. |
|
|
biometric_threshold
|
biometric_threshold | float |
얼굴 생체 인식 확인을 통과하기 위한 최소 점수 지정 |
|
|
return_confidence
|
return_confidence | boolean |
각 데이터 필드에 대한 신뢰도 점수를 반환합니다. |
|
|
return_empty
|
return_empty | boolean |
이 매개 변수를 사용하도록 설정하여 빈 필드에 null을 반환하도록 API를 가져올 수 있습니다. |
|
|
ocr_scaledown
|
ocr_scaledown | integer |
500에서 4000 또는 0 사이의 숫자 |
|
|
outputimage
|
outputimage | boolean |
문서의 잘린 이미지를 생성합니다. |
|
|
outputface
|
outputface | boolean |
문서에서 얼굴 영역의 잘린 이미지를 생성합니다. |
|
|
outputmode
|
outputmode | string |
잘린 문서와 얼굴을 URL 또는 base64로 인코딩된 콘텐츠로 출력합니다. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
이중 측면 검색을 수행할 때 이름, 문서 번호 및 문서 형식이 문서의 앞면과 뒷면 간에 일치하는지 확인합니다. 정보가 불일치하는 경우 오류 14가 throw됩니다. |
|
|
verify_expiry
|
verify_expiry | boolean |
문서가 만료 날짜에 따라 유효한지 확인합니다. |
|
|
verify_documentno
|
verify_documentno | string |
제공된 문서 번호가 문서와 일치하는지 확인합니다. |
|
|
verify_dob
|
verify_dob | string |
제공된 생년월일이 문서와 일치하는지 확인합니다. (YYYY/MM/DD) |
|
|
verify_age
|
verify_age | string |
문서 소유자가 지정된 범위 사이에서 오래된지 확인합니다. (범위, 예: 18-40) |
|
|
verify_address
|
verify_address | string |
제공된 주소가 문서와 일치하는지 확인합니다. |
|
|
verify_postcode
|
verify_postcode | string |
제공된 우편 번호가 문서와 일치하는지 확인합니다. |
|
|
country
|
country | string |
지정한 국가에서 문서를 발행했는지 확인합니다. 그렇지 않은 경우 오류 코드 10이 throw됩니다. 여러 값을 쉼표로 구분합니다. 예를 들어 "US,CA"는 미국과 캐나다의 문서를 수락합니다. |
|
|
region
|
region | string |
지정한 상태에서 문서를 발행했는지 확인합니다. 그렇지 않은 경우 오류 코드 11이 throw됩니다. 여러 값을 쉼표로 구분합니다. 예를 들어 "CA,TX"는 캘리포니아와 텍사스의 문서를 수락합니다. |
|
|
type
|
type | string |
문서가 지정된 형식 중 하나였는지 확인합니다. 그렇지 않은 경우 오류 코드 12가 throw됩니다. 예를 들어 "PD"는 여권 및 운전 면허증을 모두 수락합니다. |
|
|
checkblocklist
|
checkblocklist | boolean |
자격 증명 모음의 차단된 항목에 대해 문서 데이터를 확인합니다. 문서가 차단된 항목 오류 중 하나와 일치하는 경우 15가 throw됩니다. |
|
|
vault_save
|
vault_save | boolean |
문서 이미지 및 구문 분석된 정보를 보안 자격 증명 모음에 저장합니다. 자격 증명 모음 API 또는 웹 포털을 통해 자격 증명 모음의 문서 항목을 나열, 검색 및 업데이트할 수 있습니다. |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
문서를 인식할 수 없는 경우에도 자격 증명 모음에 문서 이미지를 저장합니다. |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
중복된 이미지가 저장되지 않도록 방지합니다. |
|
|
vault_automerge
|
vault_automerge | boolean |
동일한 문서 번호가 있는 이미지를 자격 증명 모음 내의 단일 항목에 자동으로 병합합니다. |
|
|
vault_customdata1
|
vault_customdata1 | string |
자격 증명 모음 항목과 연결할 사용자 지정 문자열을 최대 5개까지 추가하면 항목을 필터링하고 검색하는 데 유용할 수 있습니다. |
|
|
vault_customdata2
|
vault_customdata2 | string |
자격 증명 모음 항목과 연결할 사용자 지정 문자열을 최대 5개까지 추가하면 항목을 필터링하고 검색하는 데 유용할 수 있습니다. |
|
|
vault_customdata3
|
vault_customdata3 | string |
자격 증명 모음 항목과 연결할 사용자 지정 문자열을 최대 5개까지 추가하면 항목을 필터링하고 검색하는 데 유용할 수 있습니다. |
|
|
vault_customdata4
|
vault_customdata4 | string |
자격 증명 모음 항목과 연결할 사용자 지정 문자열을 최대 5개까지 추가하면 항목을 필터링하고 검색하는 데 유용할 수 있습니다. |
|
|
vault_customdata5
|
vault_customdata5 | string |
자격 증명 모음 항목과 연결할 사용자 지정 문자열을 최대 5개까지 추가하면 항목을 필터링하고 검색하는 데 유용할 수 있습니다. |
|
|
aml_check
|
aml_check | boolean |
ID 분석기 AML 데이터베이스에 대해 문서 소유자의 이름과 문서 번호를 확인합니다. |
|
|
aml_database
|
aml_database | string |
각 데이터베이스 코드를 쉼표(예: un_sc,us_ofac)로 구분합니다. |
|
|
aml_strict_match
|
aml_strict_match | boolean |
이 매개 변수를 사용하면 국적과 생일이 정확히 동일한 엔터티만 일치시켜 가양성을 줄일 수 있습니다. |
|
|
contract_generate
|
contract_generate | string |
사용자 데이터로 자동 채우기를 위한 계약 템플릿 ID입니다. |
|
|
contract_format
|
contract_format | string |
출력 문서 형식입니다. 선택 사항: PDF, DOCX, HTML. |
|
|
contract_prefill_data
|
contract_prefill_data | object |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
documentNumber
|
result.documentNumber | string |
문서와 연결된 고유 식별자(예: Passport No./Driver License No./Card Number 등) |
|
personalNumber
|
result.personalNumber | string |
국가 내 사용자와 연결된 고유 개인 식별자(예: 국가 ID 번호) |
|
이름 (첫 번째 이름)
|
result.firstName | string |
이름/지정된 이름 |
|
lastName
|
result.lastName | string |
성/가족 이름 |
|
중간 이름
|
result.middleName | string |
중간 이름 |
|
fullName
|
result.fullName | string |
이름과 성을 구분할 수 없는 경우 전체 이름이 대신 반환됩니다. |
|
firstName_local
|
result.firstName_local | string |
사용 가능한 경우 로컬 언어의 이름 |
|
lastName_local
|
result.lastName_local | string |
사용 가능한 경우 로컬 언어의 성 |
|
middleName_local
|
result.middleName_local | string |
사용 가능한 경우 로컬 언어의 중간 이름 |
|
fullName_local
|
result.fullName_local | string |
사용 가능한 경우 로컬 언어로 된 전체 이름 |
|
성
|
result.sex | string |
Gender M=Male F=Female X=Unspecified |
|
height
|
result.height | string |
사람의 높이 |
|
무게
|
result.weight | string |
사람의 무게 |
|
hairColor
|
result.hairColor | string |
헤어 컬러 - ANSI D-20 헤어 컬러 코드(3자) |
|
eyeColor
|
result.eyeColor | string |
눈 색 - ANSI D-20 눈 색 코드(3자) |
|
연령
|
result.age | integer |
문서 소유자의 나이 |
|
생년월일
|
result.dob | string |
YYYY/MM/DD의 생년월일 |
|
dob_day
|
result.dob_day | integer |
생년월일 1~31일 |
|
dob_month
|
result.dob_month | integer |
생년월일 1~12일 |
|
dob_year
|
result.dob_year | integer |
YYYY의 생년월일 |
|
만료
|
result.expiry | string |
YYYY/MM/DD의 문서 만료 날짜 |
|
expiry_day
|
result.expiry_day | integer |
만료일 1~31일 |
|
expiry_month
|
result.expiry_month | integer |
만료 1~12개월 |
|
expiry_year
|
result.expiry_year | integer |
YYYY의 만료 연도 |
|
daysToExpiry
|
result.daysToExpiry | integer |
문서가 만료되기 전의 일 수 |
|
발급
|
result.issued | string |
YYYY/MM/DD의 문제 날짜 |
|
issued_day
|
result.issued_day | integer |
발행일 1~31일 |
|
issued_month
|
result.issued_month | integer |
문제 1~12월 |
|
issued_year
|
result.issued_year | integer |
YYYY의 문제 연도 |
|
daysFromIssue
|
result.daysFromIssue | integer |
문서가 발행된 후의 일 수입니다. |
|
주소1
|
result.address1 | string |
주소 줄 1 |
|
주소2
|
result.address2 | string |
주소 줄 2 |
|
우편 번호
|
result.postcode | string |
주소 우편 번호 |
|
placeOfBirth
|
result.placeOfBirth | string |
출생지 |
|
vehicleClass
|
result.vehicleClass | string |
운전 면허증 차량 클래스 |
|
제한
|
result.restrictions | string |
운전 면허증 제한 |
|
승인
|
result.endorsement | string |
운전면허증 인증 |
|
optionalData
|
result.optionalData | string |
문서에 포함된 추가 지정되지 않은 데이터 |
|
optionalData2
|
result.optionalData2 | string |
문서에 포함된 추가 지정되지 않은 데이터 |
|
documentType
|
result.documentType | string |
문서 유형: P=Passport, D=운전 면허증, I=ID 카드, V=비자, R=레지던스 카드, O=기타 |
|
documentSide
|
result.documentSide | string |
문서의 측면: FRONT, BACK 또는 BIODATA |
|
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
문서 발급자 하위 리소스/상태입니다. (예: 캘리포니아) |
|
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
문서 발급자 하위/상태 약어입니다. (예: CA) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
발급된 국가 문서입니다. (예: 미국) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
ISO2에서 발급된 국가 코드를 문서화합니다. (예: 미국) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
ISO3에서 발급된 국가 코드를 문서화합니다. (예: 미국) |
|
nationality_full
|
result.nationality_full | string |
문서 소유자 국적. (예: 미국) |
|
nationality_iso2
|
result.nationality_iso2 | string |
ISO2의 문서 소유자 국적 (예: 미국) |
|
nationality_iso3
|
result.nationality_iso3 | string |
ISO3의 문서 소유자 국적 (예: 미국) |
|
internalId
|
result.internalId | string |
ID 분석기 시스템에서 고유한 문서 ID를 식별하는 데 사용되는 동일한 유형의 문서에는 동일한 ID가 있어야 합니다. |
|
documentNumber
|
confidence.documentNumber | float |
documentNumber의 신뢰 수준 |
|
이름 (첫 번째 이름)
|
confidence.firstName | float |
firstName의 신뢰 수준 |
|
lastName
|
confidence.lastName | float |
성/가족 이름의 신뢰 수준 |
|
중간 이름
|
confidence.middleName | float |
중간 이름의 신뢰 수준 |
|
dob_month
|
confidence.dob_month | float |
dob_month 신뢰 수준 |
|
dob_day
|
confidence.dob_day | float |
dob_day 신뢰 수준 |
|
dob_year
|
confidence.dob_year | float |
dob_year 신뢰 수준 |
|
issued_month
|
confidence.issued_month | float |
issued_month 신뢰 수준 |
|
issued_day
|
confidence.issued_day | float |
issued_day 신뢰 수준 |
|
issued_year
|
confidence.issued_year | float |
issued_year 신뢰 수준 |
|
expiry_month
|
confidence.expiry_month | float |
신뢰 수준 expiry_month |
|
expiry_day
|
confidence.expiry_day | float |
expiry_day 신뢰 수준 |
|
expiry_year
|
confidence.expiry_year | float |
신뢰 수준 expiry_year |
|
성
|
confidence.sex | float |
섹스의 신뢰 수준 |
|
height
|
confidence.height | float |
높이의 신뢰도 수준 |
|
무게
|
confidence.weight | float |
신뢰도 수준(가중치) |
|
주소1
|
confidence.address1 | float |
address1의 신뢰 수준 |
|
주소2
|
confidence.address2 | float |
주소 2의 신뢰 수준 |
|
우편 번호
|
confidence.postcode | float |
우편 번호의 신뢰 수준 |
|
vehicleClass
|
confidence.vehicleClass | float |
vehicleClass의 신뢰 수준 |
|
제한
|
confidence.restrictions | float |
신뢰도 제한 수준 |
|
승인
|
confidence.endorsement | float |
신뢰 수준 보증 |
|
eyeColor
|
confidence.eyeColor | float |
eyeColor의 신뢰 수준 |
|
연령
|
confidence.age | float |
나이의 신뢰 수준 |
|
생년월일
|
confidence.dob | float |
dob의 신뢰 수준 |
|
daysToExpiry
|
confidence.daysToExpiry | float |
신뢰 수준 일 수ToExpiry |
|
만료
|
confidence.expiry | float |
신뢰 수준 만료 |
|
발급
|
confidence.issued | float |
발급된 신뢰 수준 |
|
daysFromIssue
|
confidence.daysFromIssue | float |
신뢰도 수준(daysFromIssue) |
|
fullName
|
confidence.fullName | float |
fullName의 신뢰 수준 |
|
isIdentical
|
face.isIdentical | boolean |
생체 인식 확인 통과 또는 실패 |
|
자신
|
face.confidence | string |
두 얼굴이 얼마나 비슷한지에 대해 0에서 1 사이의 값이며, 1은 동일합니다. |
|
오류
|
face.error | integer |
오류 코드 |
|
error_message
|
face.error_message | string |
오류 메시지입니다. 예: 얼굴 이미지 내에서 얼굴 데이터를 찾을 수 없음 |
|
전달
|
verification.passed | boolean |
문서가 모든 확인을 통과한 경우 true를 반환합니다. 문서가 하나 이상의 확인 유형에 실패한 경우 false를 반환합니다. |
|
얼굴
|
verification.result.face | boolean |
생체 인식 확인을 사용하는 경우 유사성 신뢰도 점수가 설정된 임계값을 초과하는지 여부입니다. |
|
notexpired
|
verification.result.notexpired | boolean |
문서가 아직 만료되지 않았는지 여부입니다. |
|
이름
|
verification.result.name | boolean |
제공된 이름이 ID에서 구문 분석된 이름과 일치하는지 여부입니다. |
|
생년월일
|
verification.result.dob | boolean |
제공된 생일이 ID에서 구문 분석된 생일과 일치하는지 여부입니다. |
|
documentNumber
|
verification.result.documentNumber | boolean |
제공된 문서 번호가 ID에서 구문 분석된 문서 번호와 일치하는지 여부입니다. |
|
우편 번호
|
verification.result.postcode | boolean |
제공된 우편 번호가 ID에서 구문 분석된 우편 번호와 일치하는지 여부입니다. |
|
address
|
verification.result.address | boolean |
제공된 주소가 ID에서 구문 분석된 주소와 일치하는지 여부입니다. |
|
checkdigit
|
verification.result.checkdigit | boolean |
문서 형식에 check digit/soundex 알고리즘이 있는 경우 확인 숫자가 유효한지 여부입니다. |
|
연령
|
verification.result.age | boolean |
문서 소유자가 설정된 기간 범위 내에 있는지 여부입니다. |
|
cccode
|
verification.result.cccode | boolean |
문서 형식에 CC 코드(중국어 상용 코드) 구현이 있는 경우 CC 코드가 유효한지 여부입니다. |
|
점수
|
authentication.score | float |
점수는 0에서 1 사이의 부동 소수점이 됩니다. 유효한 문서는 점수가 1에 가까울 것이며, 가짜 또는 편집된 문서는 점수가 0에 가깝습니다. 경계를 결정하는 것은 사용자의 재량입니다. 좋은 출발점은 0.5 미만의 점수를 거부하는 것입니다. |
|
전달
|
authentication.breakdown.data_visibility.passed | boolean | |
|
전달
|
authentication.breakdown.image_quality.passed | boolean | |
|
전달
|
authentication.breakdown.feature_referencing.passed | boolean | |
|
전달
|
authentication.breakdown.exif_check.passed | boolean | |
|
코드
|
authentication.breakdown.exif_check.code | integer | |
|
이유
|
authentication.breakdown.exif_check.reason | string | |
|
severity
|
authentication.breakdown.exif_check.severity | string | |
|
전달
|
authentication.breakdown.publicity_check.passed | boolean | |
|
코드
|
authentication.breakdown.publicity_check.code | integer | |
|
이유
|
authentication.breakdown.publicity_check.reason | string | |
|
severity
|
authentication.breakdown.publicity_check.severity | string | |
|
전달
|
authentication.breakdown.text_analysis.passed | boolean | |
|
전달
|
authentication.breakdown.biometric_analysis.passed | boolean | |
|
전달
|
authentication.breakdown.security_feature_check.passed | boolean | |
|
코드
|
authentication.breakdown.security_feature_check.code | integer | |
|
이유
|
authentication.breakdown.security_feature_check.reason | string | |
|
severity
|
authentication.breakdown.security_feature_check.severity | string | |
|
전달
|
authentication.breakdown.recapture_check.passed | boolean | |
|
코드
|
authentication.breakdown.recapture_check.code | integer | |
|
이유
|
authentication.breakdown.recapture_check.reason | string | |
|
severity
|
authentication.breakdown.recapture_check.severity | string | |
|
warning
|
authentication.warning | array of string |
문서의 유효성에 대한 경고 메시지를 포함하는 문자열 배열입니다. |
|
aml
|
aml | array of object |
AML 일치 목록을 포함하는 배열은 일치하는 항목이 없으면 빈 배열을 반환합니다. 자세한 내용은 AML API 참조를 참조하세요. |
|
개체
|
aml.entity | string |
개인 또는 적법성 |
|
fullname
|
aml.fullname | array of string |
개인 또는 법인 이름 |
|
이름
|
aml.firstname | array of string |
개인 이름 |
|
lastname
|
aml.lastname | array of string |
사람 성 |
|
middlename
|
aml.middlename | array of string |
사람 중간 이름 |
|
별명
|
aml.alias | array of string |
엔터티의 대체 또는 외신 이름 |
|
생년월일
|
aml.dob | array of string |
페론의 생일은 YYYY, YYYY-MM 또는 YYYY-MM-DD 형식으로 올 수 있습니다. |
|
address
|
aml.address | array of string |
엔터티의 주소 또는 거주 국가 |
|
국적
|
aml.nationality | array of string |
엔터티의 국가 또는 국적 |
|
출생지
|
aml.birthplace | array of string |
페론의 출생지 |
|
gender
|
aml.gender | array of string |
페론의 성별: M 또는 F |
|
documentnumber
|
aml.documentnumber | array of object |
엔터티와 연결된 문서 목록입니다. |
|
아이디
|
aml.documentnumber.id | string |
문서 번호 |
|
id_formatted
|
aml.documentnumber.id_formatted | string |
영숫자 문서 번호 |
|
country
|
aml.documentnumber.country | string |
ISO2 국가 코드 |
|
type
|
aml.documentnumber.type | string |
P = Passport 번호, I = ID 번호, D = 운전 면허증 번호, O = 기타/알 수 없는 문서 유형 |
|
프로그램
|
aml.program | array of string |
제재 프로그램 |
|
메모
|
aml.note | array of string |
엔터티에 대한 추가 참고 사항 |
|
time
|
aml.time | string |
엔터티가 원본 목록에 추가되었거나 마지막으로 업데이트된 경우 UTC TZ 타임스탬프 |
|
status
|
aml.status | string |
제재 대상의 엔터티 또는 현재 상태의 위치/제목 |
|
source
|
aml.source | array of string |
공식 원본 URL 목록 |
|
데이터베이스
|
aml.database | string |
ID 분석기 AML 데이터베이스 코드 |
|
schema(스키마)
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
생성된 문서에 대한 URL |
|
오류
|
contract.error | string |
계약이 생성되지 않은 경우 이 필드에는 "잘못된 계약 템플릿 ID"와 같은 이유가 포함됩니다. |
|
vaultid
|
vaultid | string |
vault_save 사용하도록 설정된 경우 자격 증명 모음 항목에 대한 고유 식별자입니다. |
|
일치률
|
matchrate | float |
API에서 성공적으로 인식된 필드의 비율이며, 낮은 비율은 문서 이미지가 너무 흐릿하다는 것을 나타냅니다. |
|
output
|
output | string |
outputimage가 true로 설정되고 outputmode가 URL인 경우 이 필드에는 잘린 문서 이미지를 가리키는 URL(또는 이중 검색을 위한 URL 배열)이 포함됩니다. 링크는 600초 동안만 유지되며, 이후 언제든지 제거됩니다. |
|
outputface
|
outputface | string |
outputface가 true로 설정되고 outputmode가 URL인 경우 이 필드에는 잘린 얼굴 이미지를 가리키는 URL이 포함됩니다. 링크는 600초 동안만 유지되며, 이후 언제든지 제거됩니다. |
|
자른
|
cropped | string |
outputimage가 true로 설정되고 outputmode가 base64인 경우 이 필드에는 잘린 문서의 base64로 인코딩된 이미지(또는 이중 스캔을 위해 base64로 인코딩된 이미지 배열)가 JPEG 형식으로 포함됩니다. |
|
크롭페이스
|
croppedface | string |
outputface가 true로 설정되고 outputmode가 base64인 경우 이 필드에는 문서의 잘린 얼굴 영역의 base64로 인코딩된 이미지가 JPEG 형식으로 포함됩니다. |
|
executionTime
|
executionTime | float |
API 작업에 걸린 시간(초)입니다. |
|
responseID
|
responseID | string |
요청/응답을 식별하는 고유 식별자입니다. |
|
quota
|
quota | integer |
남은 API 할당량은 무료 또는 연간 구독자의 경우 매월 시작 또는 월별 구독자에 대한 각 청구 주기의 시작 부분에서 다시 설정됩니다. 구독 플랜이 있는 경우 크레딧 전에 월별 할당량이 사용됩니다. |
|
크레딧
|
credit | integer |
계정에 대한 남은 테스트 크레딧입니다. 구독 플랜이 있는 경우 크레딧 전에 월별 할당량이 사용됩니다. |