API SPEC · V1 · GADEVELOPER REFERENCE

    개발자 API

    AML 스크리닝을 위한 REST API

    제재, PEP, 범죄 감시 리스트, 부정적 미디어, KYB/실제소유자 스크리닝을 온보딩, 모니터링, 거래 플로에 직접 연동하십시오. API는 정식 운영 중입니다. API 키로 인증하고 포털이 사용하는 것과 동일한 스크리닝 엔진을 호출하십시오.

    API v1 정식 운영 중

    API 키 인증과 등급별 속도 제한을 갖추고 정식 서비스로 제공됩니다. /api/v1/docs의 인터랙티브 OpenAPI 문서에서 모든 엔드포인트를 확인하십시오.

    §01빠른 시작

    01 / 05
    STEP 01

    1. API 키 생성

    대시보드에서 범위가 지정된 API 키를 생성하거나, 서버 간 요청을 위해 계정 Bearer 토큰으로 프로그래밍 방식으로 발급하십시오.

    curl
    curl -X POST https://screenveritai.com/api/v1/keys \
      -H "Authorization: Bearer <SUPABASE_JWT>" \
      -H "Content-Type: application/json" \
      -d '{"name":"server-key","permissions":["search:read","search:write"]}'
    STEP 02

    2. 첫 검색 실행

    X-API-Key 헤더와 함께 대상을 제출하십시오. API는 처리가 완료되면 조회할 검색 ID를 반환합니다.

    curl
    curl -X POST https://screenveritai.com/api/v1/search \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"deep_research"}'
    STEP 03

    3. 일괄 작업 제출

    CSV/XLSX 파일 하나로 여러 대상을 한 번에 스크리닝하고, 배치가 완료되면 행별 결과 또는 내보내기를 조회하십시오.

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02핵심 엔드포인트

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    단일 대상에 대한 스크리닝 요청을 생성합니다. 검색 ID와 처리 상태를 반환합니다. 계정, 커버리지, 상태 확인 엔드포인트도 /api/v1 하위에서 제공됩니다.

    인증: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    대량 스크리닝을 위해 CSV/XLSX 파일을 제출한 뒤, 작업 완료 시 행별 결과 또는 내보내기를 조회합니다.

    인증: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    범위가 지정된 권한, 등급별 속도 제한, 사용량 추적 기능을 갖춘 API 자격 증명을 생성하고 관리합니다.

    인증: Bearer 토큰 (account)

    §03팀이 API를 사용하는 이유

    03 / 05
    • 제재, PEP, 범죄 감시 리스트, 부정적 미디어, KYB/실제소유자 스크리닝을 위한 단일 통합
    • X-API-Key 헤더를 통한 API 키 인증과 최소 권한 접근을 위한 권한 범위 지정 키
    • 거버넌스와 비용 관리를 위한 사용량 로깅이 포함된 등급별 속도 제한
    • /api/v1 하위의 검색, 일괄, 키, 계정, 커버리지, 상태 확인 엔드포인트
    • /api/v1/docs의 인터랙티브 OpenAPI 문서와 기계 판독 가능한 OpenAPI 스키마
    • 감사 로그, 사건 파일, 후속 의사결정에 바로 활용 가능한 구조화된 출력

    §05API FAQ

    05 / 05
    Q01

    API 요청은 어떻게 인증합니까?

    /api/v1/search와 /api/v1/batch에 대한 스크리닝 요청은 X-API-Key 헤더로 전송하는 API 키로 인증합니다. 대시보드에서 키를 생성하거나, 계정 Bearer 토큰으로 인증한 뒤 /api/v1/keys를 통해 프로그래밍 방식으로 생성할 수 있습니다.

    Q02

    API는 정식으로 이용할 수 있습니까?

    네. API v1은 정식으로 운영되고 있습니다. API 키로 인증한 뒤 검색, 일괄, 키 관리 엔드포인트를 호출하고, /api/v1/docs의 인터랙티브 OpenAPI 문서에서 모든 기능을 확인하십시오.

    Q03

    API 키 권한을 범위 지정할 수 있습니까?

    네. 키는 search:read, search:write, batch:read, batch:write 등의 권한을 지원하므로 연동별로 최소 권한 접근을 적용할 수 있습니다.

    Q04

    어떤 속도 제한이 적용됩니까?

    속도 제한은 구독 등급별로 배정되며 API 키 단위로 적용됩니다. 응답 헤더에 제한량, 잔여 할당량, 초기화 시각이 포함되어 있어 원활하게 조절할 수 있습니다.

    Q05

    엔드포인트를 빠르게 테스트할 수 있는 곳은 어디입니까?

    /api/v1/docs의 인터랙티브 문서에서 Swagger 테스트를 이용하고, /api/v1/redoc에서 참조 스타일 문서를 확인하십시오. OpenAPI 스키마는 /api/v1/openapi.json에서 제공됩니다.