portone_server_sdk.IdentityVerificationClient

portone_server_sdk.IdentityVerificationClient#

class portone_server_sdk.IdentityVerificationClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Parameters:

  • secret (str) – 포트원 API Secret입니다.

  • base_url (str, optional) – 포트원 REST API 주소입니다. 기본값은 `”https://api.portone.io”`입니다.

  • store_id – 하위 상점에 대해 기능을 사용할 때 필요한 하위 상점의 ID입니다.

Methods

__init__(*, secret[, base_url, store_id])

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

confirm_identity_verification(*, ...[, otp])

본인인증 확인

confirm_identity_verification_async(*, ...)

본인인증 확인

get_identity_verification(*, ...)

본인인증 단건 조회

get_identity_verification_async(*, ...)

본인인증 단건 조회

get_identity_verifications(*[, page, sort, ...])

본인인증 내역 다건 조회

get_identity_verifications_async(*[, page, ...])

본인인증 내역 다건 조회

resend_identity_verification(*, ...)

SMS 본인인증 요청 재전송

resend_identity_verification_async(*, ...)

SMS 본인인증 요청 재전송

send_identity_verification(*, ...[, custom_data])

본인인증 요청 전송

send_identity_verification_async(*, ...[, ...])

본인인증 요청 전송
get_identity_verification(*, identity_verification_id: str) → FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification | dict#

본인인증 단건 조회

주어진 아이디에 대응되는 본인인증 내역을 조회합니다.

Parameters:

identity_verification_id (str) – 조회할 본인인증 아이디

Raises:

  • GetIdentityVerificationError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_identity_verification_async(*, identity_verification_id: str) → FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification | dict#

본인인증 단건 조회

주어진 아이디에 대응되는 본인인증 내역을 조회합니다.

Parameters:

identity_verification_id (str) – 조회할 본인인증 아이디

Raises:

  • GetIdentityVerificationError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_identity_verifications(*, page: PageInput | None = None, sort: IdentityVerificationSortInput | None = None, filter: IdentityVerificationFilterInput | None = None) → GetIdentityVerificationsResponse#

본인인증 내역 다건 조회

주어진 조건에 맞는 본인인증 내역들을 페이지 기반으로 조회합니다.

Parameters:

  • page (PageInput, optional) –

    요청할 페이지 정보

    미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.

  • sort (IdentityVerificationSortInput, optional) –

    정렬 조건

    미 입력 시 sortBy: REQUESTED_AT, sortOrder: DESC 으로 기본값이 적용됩니다.

  • filter (IdentityVerificationFilterInput, optional) – 조회할 본인인증 내역 조건 필터

Raises:

  • GetIdentityVerificationsError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_identity_verifications_async(*, page: PageInput | None = None, sort: IdentityVerificationSortInput | None = None, filter: IdentityVerificationFilterInput | None = None) → GetIdentityVerificationsResponse#

본인인증 내역 다건 조회

주어진 조건에 맞는 본인인증 내역들을 페이지 기반으로 조회합니다.

Parameters:

  • page (PageInput, optional) –

    요청할 페이지 정보

    미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.

  • sort (IdentityVerificationSortInput, optional) –

    정렬 조건

    미 입력 시 sortBy: REQUESTED_AT, sortOrder: DESC 으로 기본값이 적용됩니다.

  • filter (IdentityVerificationFilterInput, optional) – 조회할 본인인증 내역 조건 필터

Raises:

  • GetIdentityVerificationsError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

send_identity_verification(*, identity_verification_id: str, channel_key: str, customer: SendIdentityVerificationBodyCustomer, custom_data: str | None = None, bypass: dict, operator: Literal['SKT', 'KT', 'LGU', 'SKT_MVNO', 'KT_MVNO', 'LGU_MVNO'] | str, method: Literal['SMS', 'APP'] | str) → SendIdentityVerificationResponse#

본인인증 요청 전송

SMS 또는 APP 방식을 이용하여 본인인증 요청을 전송합니다.

Parameters:

  • identity_verification_id (str) – 본인인증 아이디

  • channel_key (str) – 채널 키

  • customer (SendIdentityVerificationBodyCustomer) – 고객 정보

  • custom_data (str, optional) – 사용자 지정 데이터

  • bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

  • operator (IdentityVerificationOperator) – 통신사

  • method (IdentityVerificationMethod) – 본인인증 방식

Raises:

  • SendIdentityVerificationError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async send_identity_verification_async(*, identity_verification_id: str, channel_key: str, customer: SendIdentityVerificationBodyCustomer, custom_data: str | None = None, bypass: dict, operator: Literal['SKT', 'KT', 'LGU', 'SKT_MVNO', 'KT_MVNO', 'LGU_MVNO'] | str, method: Literal['SMS', 'APP'] | str) → SendIdentityVerificationResponse#

본인인증 요청 전송

SMS 또는 APP 방식을 이용하여 본인인증 요청을 전송합니다.

Parameters:

  • identity_verification_id (str) – 본인인증 아이디

  • channel_key (str) – 채널 키

  • customer (SendIdentityVerificationBodyCustomer) – 고객 정보

  • custom_data (str, optional) – 사용자 지정 데이터

  • bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

  • operator (IdentityVerificationOperator) – 통신사

  • method (IdentityVerificationMethod) – 본인인증 방식

Raises:

  • SendIdentityVerificationError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

confirm_identity_verification(*, identity_verification_id: str, otp: str | None = None) → ConfirmIdentityVerificationResponse#

본인인증 확인

요청된 본인인증에 대한 확인을 진행합니다.

Parameters:

  • identity_verification_id (str) – 본인인증 아이디

  • otp (str, optional) –

    OTP (One-Time Password)

    SMS 방식에서만 사용됩니다.

Raises:
async confirm_identity_verification_async(*, identity_verification_id: str, otp: str | None = None) → ConfirmIdentityVerificationResponse#

본인인증 확인

요청된 본인인증에 대한 확인을 진행합니다.

Parameters:

  • identity_verification_id (str) – 본인인증 아이디

  • otp (str, optional) –

    OTP (One-Time Password)

    SMS 방식에서만 사용됩니다.

Raises:
resend_identity_verification(*, identity_verification_id: str) → ResendIdentityVerificationResponse#

SMS 본인인증 요청 재전송

SMS 본인인증 요청을 재전송합니다.

Parameters:

identity_verification_id (str) – 본인인증 아이디

Raises:

  • ResendIdentityVerificationError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async resend_identity_verification_async(*, identity_verification_id: str) → ResendIdentityVerificationResponse#

SMS 본인인증 요청 재전송

SMS 본인인증 요청을 재전송합니다.

Parameters:

identity_verification_id (str) – 본인인증 아이디

Raises:

  • ResendIdentityVerificationError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우