portone_server_sdk.identity_verification

portone_server_sdk.identity_verification#

Classes

`ConfirmIdentityVerificationBody`	본인인증 확인을 위한 입력 정보
`ConfirmIdentityVerificationResponse`	본인인증 확인 성공 응답
`FailedIdentityVerification`	실패한 본인인증 내역
`IdentityVerificationFailure`	본인인증 실패 정보
`IdentityVerificationRequestedCustomer`	요청 시 고객 정보
`IdentityVerificationVerifiedCustomer`	인증된 고객 정보
`ReadyIdentityVerification`	준비 상태의 본인인증 내역
`ResendIdentityVerificationResponse`	본인인증 요청 재전송 성공 응답
`SendIdentityVerificationBody`	본인인증 요청을 위한 입력 정보
`SendIdentityVerificationBodyCustomer`	본인인증 요청을 위한 고객 정보
`SendIdentityVerificationResponse`	본인인증 요청 전송 성공 응답
`VerifiedIdentityVerification`	완료된 본인인증 내역
`IdentityVerificationClient`

class portone_server_sdk.identity_verification.ConfirmIdentityVerificationBody#

본인인증 확인을 위한 입력 정보

store_id: str | None#

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

otp: str | None#

OTP (One-Time Password)

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

class portone_server_sdk.identity_verification.ConfirmIdentityVerificationResponse#

본인인증 확인 성공 응답

identity_verification: VerifiedIdentityVerification#: 완료된 본인인증 내역

class portone_server_sdk.identity_verification.FailedIdentityVerification#

실패한 본인인증 내역

status: Literal['FAILED']#: 본인인증 상태

id: str#: 본인인증 내역 아이디

requested_customer: IdentityVerificationRequestedCustomer#: 요청 시 고객 정보

requested_at: str#: 본인인증 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

failure: IdentityVerificationFailure#: 본인인증 실패 정보

channel: SelectedChannel | None#: 사용된 본인인증 채널

custom_data: str | None#: 사용자 지정 데이터

class portone_server_sdk.identity_verification.IdentityVerificationFailure#

본인인증 실패 정보

reason: str | None#: 실패 사유

pg_code: str | None#: PG사 실패 코드

pg_message: str | None#: PG사 실패 메시지

class portone_server_sdk.identity_verification.IdentityVerificationRequestedCustomer#

요청 시 고객 정보

id: str | None#: 식별 아이디

name: str | None#: 이름

phone_number: str | None#

전화번호

특수 문자(-) 없이 숫자로만 이루어진 번호 형식입니다.

class portone_server_sdk.identity_verification.IdentityVerificationVerifiedCustomer#

인증된 고객 정보

name: str#: 이름

birth_date: str#

생년월일 (yyyy-MM-dd)

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

id: str | None#: 식별 아이디

operator: Literal['SKT', 'KT', 'LGU', 'SKT_MVNO', 'KT_MVNO', 'LGU_MVNO'] | None#

통신사

다날: 별도 계약이 필요합니다. KG이니시스: 제공하지 않습니다.

phone_number: str | None#

전화번호

특수 문자(-) 없이 숫자로만 이루어진 번호 형식입니다. 다날: 별도 계약이 필요합니다. KG이니시스: 항상 제공합니다.

gender: Literal['MALE', 'FEMALE', 'OTHER'] | None#

성별

다날: 항상 제공합니다. KG이니시스: 항상 제공합니다.

is_foreigner: bool | None#

외국인 여부

다날: 별도 계약이 필요합니다. KG이니시스: 항상 제공합니다.

ci: str | None#

CI (개인 고유 식별키)

개인을 식별하기 위한 고유 정보입니다. 다날: 항상 제공합니다. KG이니시스: 카카오를 제외한 인증사에서 제공합니다.

di: str | None#

DI (사이트별 개인 고유 식별키)

중복 가입을 방지하기 위해 개인을 식별하는 사이트별 고유 정보입니다. 다날: 항상 제공합니다. KG이니시스: 제공하지 않습니다.

class portone_server_sdk.identity_verification.ReadyIdentityVerification#

준비 상태의 본인인증 내역

status: Literal['READY']#: 본인인증 상태

id: str#: 본인인증 내역 아이디

requested_customer: IdentityVerificationRequestedCustomer#: 요청 시 고객 정보

requested_at: str#: 본인인증 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

channel: SelectedChannel | None#: 사용된 본인인증 채널

custom_data: str | None#: 사용자 지정 데이터

class portone_server_sdk.identity_verification.ResendIdentityVerificationResponse#: 본인인증 요청 재전송 성공 응답

class portone_server_sdk.identity_verification.SendIdentityVerificationBody#

본인인증 요청을 위한 입력 정보

channel_key: str#: 채널 키

customer: SendIdentityVerificationBodyCustomer#: 고객 정보

operator: Literal['SKT', 'KT', 'LGU', 'SKT_MVNO', 'KT_MVNO', 'LGU_MVNO']#: 통신사

method: Literal['SMS', 'APP']#: 본인인증 방식

store_id: str | None#

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

custom_data: str | None#: 사용자 지정 데이터

bypass: dict | None#: PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

class portone_server_sdk.identity_verification.SendIdentityVerificationBodyCustomer#

본인인증 요청을 위한 고객 정보

name: str#: 이름

phone_number: str#

전화번호

특수 문자(-) 없이 숫자만 입력합니다.

ip_address: str#

IP 주소

고객의 요청 속도 제한에 사용됩니다.

id: str | None#: 식별 아이디

identity_number: str | None#

주민등록번호 앞 7자리

SMS 방식의 경우 필수로 입력합니다.

class portone_server_sdk.identity_verification.SendIdentityVerificationResponse#: 본인인증 요청 전송 성공 응답

class portone_server_sdk.identity_verification.VerifiedIdentityVerification#

완료된 본인인증 내역

status: Literal['VERIFIED']#: 본인인증 상태

id: str#: 본인인증 내역 아이디

verified_customer: IdentityVerificationVerifiedCustomer#: 인증된 고객 정보

requested_at: str#: 본인인증 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

verified_at: str#: 본인인증 완료 시점 (RFC 3339 date-time)

pg_tx_id: str#: 본인인증 내역 PG사 아이디

pg_raw_response: str#: PG사 응답 데이터

channel: SelectedChannel | None#: 사용된 본인인증 채널

custom_data: str | None#: 사용자 지정 데이터

class portone_server_sdk.identity_verification.IdentityVerificationClient#

get_identity_verification(*, identity_verification_id: str) → FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification#

본인인증 단건 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

본인인증 단건 조회

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – 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'], method: Literal['SMS', 'APP']) → 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:

ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationAlreadySentError – 본인인증 건이 이미 API로 요청된 상태인 경우 본인인증 건이 이미 API로 요청된 상태인 경우
IdentityVerificationAlreadyVerifiedError – 본인인증 건이 이미 인증 완료된 상태인 경우 본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxTransactionCountReachedError – 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – 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'], method: Literal['SMS', 'APP']) → 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:

ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationAlreadySentError – 본인인증 건이 이미 API로 요청된 상태인 경우 본인인증 건이 이미 API로 요청된 상태인 경우
IdentityVerificationAlreadyVerifiedError – 본인인증 건이 이미 인증 완료된 상태인 경우 본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxTransactionCountReachedError – 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – 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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationAlreadyVerifiedError – 본인인증 건이 이미 인증 완료된 상태인 경우 본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
IdentityVerificationNotSentError – 본인인증 건이 API로 요청된 상태가 아닌 경우 본인인증 건이 API로 요청된 상태가 아닌 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationAlreadyVerifiedError – 본인인증 건이 이미 인증 완료된 상태인 경우 본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
IdentityVerificationNotSentError – 본인인증 건이 API로 요청된 상태가 아닌 경우 본인인증 건이 API로 요청된 상태가 아닌 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

resend_identity_verification(*, identity_verification_id: str) → ResendIdentityVerificationResponse#

SMS 본인인증 요청 재전송

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationAlreadyVerifiedError – 본인인증 건이 이미 인증 완료된 상태인 경우 본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
IdentityVerificationNotSentError – 본인인증 건이 API로 요청된 상태가 아닌 경우 본인인증 건이 API로 요청된 상태가 아닌 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

SMS 본인인증 요청 재전송

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

Parameters:

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

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
IdentityVerificationAlreadyVerifiedError – 본인인증 건이 이미 인증 완료된 상태인 경우 본인인증 건이 이미 인증 완료된 상태인 경우
IdentityVerificationNotFoundError – 요청된 본인인증 건이 존재하지 않는 경우 요청된 본인인증 건이 존재하지 않는 경우
IdentityVerificationNotSentError – 본인인증 건이 API로 요청된 상태가 아닌 경우 본인인증 건이 API로 요청된 상태가 아닌 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

portone_server_sdk.identity_verification

Contents

portone_server_sdk.identity_verification#