메인 콘텐츠로 건너뛰기
POST
/
document
ID Liveness Detection
curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/document \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idImage": "base64_encoded_id_document_image",
  "pipelines": {
    "sr": true,
    "pc": true,
    "ps": true
  },
  "useUpcomingVersion": true,
  "callbackUrl": "https://your-domain.com/callback"
}
'
{
  "apiType": "id_live_doc",
  "transactionId": "txn_123456789",
  "engineVersion": "id_liveness@3.4.2",
  "result": {
    "screenReplay": {
      "liveness_score": 99
    },
    "paperPrinted": {
      "liveness_score": 82
    },
    "replacePortraits": {
      "liveness_score": 100
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

ID Liveness API 섹션을 통해 사용자는 제공된 이미지를 분석하여 변조나 위조의 흔적을 찾아 ID 문서의 진위 여부를 확인할 수 있습니다. 사용자는 다양한 파이프라인을 활용하여 화면 캡처, 인쇄된 복사본, 초상화 교체를 감지하여 ID 문서의 무결성을 보장할 수 있습니다. 완료 시 사용자는 인식 결과와 거래 정보를 받게 되어 안전한 신원 확인 프로세스를 원활하게 진행할 수 있습니다.
Notes
이미지를 정상적으로 진위 여부를 확인하기 위해서는, 반드시 이미지에 공백이 필요합니다.
신분증이 이미지에서 일정부분 공백없이 가득 찬 상태에서는 정상 값이 도출되지 않을 수 있습니다.
예시 이미지:

​
응답 속성

​
transactionId
string
인식 요청과 관련된 거래의 고유 식별자입니다.
​
result
string
각 파이프라인에 대한 감지 점수를 반환합니다.파이프라인 값:
  • screenReplay - liveness_score
  • paperPrinted - liveness_score
  • replacePortraits - liveness_score
​
errorCode
string
문제 해결을 위한 특정 오류를 식별합니다.오류 코드 값:
  • 1001 - Workspace is unavailable | 워크스페이스를 사용할 수 없습니다
  • 1003 - Fail to process data | 데이터 처리에 실패했습니다
  • 1005 - idImage is required | idImage가 필요합니다
  • 1007 - pipelines is required | pipelines가 필요합니다
  • 1008 - invalid pipelines format | 잘못된 pipelines 형식입니다
  • 1009 - Fail to analyze document | 문서 분석에 실패했습니다
  • 1010 - callbackUrl is required | callbackUrl이 필요합니다
​
message
string
오류에 대한 간단한 설명입니다. 자세한 내용은 오류 코드를 참조하세요.

인증

​
x-api-key
string
header
필수

본문

application/json
​
idImage
file
필수

Base64 encoded ID document image to analyze for liveness detection. The image should contain a clear view of the ID document.

​
pipelines
object
필수

Forgery detection options object

​
useUpcomingVersion
boolean
기본값:False

Use the upcoming version of the liveness engine

​
callbackUrl
string<uri>

Optional callback URL where the liveness detection results will be sent upon completion. If provided, the process works asynchronously.

예시:

"https://your-domain.com/callback"

응답

Successful liveness detection analysis

​
apiType
string
예시:

"id_live_doc"

​
transactionId
string

Unique transaction identifier

예시:

"txn_123456789"

​
engineVersion
string

Liveness Engine's version for each request

예시:

"id_liveness@3.4.2"

​
result
object