휴대폰 번호 3요소 검증 API 연동 설명

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

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

​

신청 절차

​

기본 사용

• accept: 어떤 형식의 응답 결과를 받고 싶은지, 여기서는 application/json 즉 JSON 형식으로 입력합니다.
• authorization: API 호출을 위한 키, 신청 후 바로 드롭다운에서 선택할 수 있습니다.

• name: 처리할 사용자 이름, 필수 매개변수입니다.
• phone: 처리할 휴대폰 번호, 필수 매개변수입니다.
• id_card: 처리할 사용자 신분증 번호, 필수 매개변수입니다.
• verify_mode: 검증 모드(장문/단문).
• encrypt_list/ciphertext_blob/iv: 선택적 암호화 매개변수, 필요에 따라 민감한 필드를 암호화합니다.

{
  "result": "0",
  "description": "인증 통과",
  "isp": "이동통신",
  "result_detail": null
}

• result, 인증 결과 코드, 요금 상황은 다음과 같습니다.
  • 유료 결과 코드:
    • 0: 검증 결과 일치
    • 1: 검증 결과 불일치
  • 무료 결과 코드:
    • -1: 기록 없음
    • -2: 엔진 알 수 없는 오류
    • -3: 엔진 서비스 예외
    • -4: 이름 검증 통과하지 않음
    • -5: 휴대폰 번호 불법
    • -6: 인증 횟수가 당일 제한을 초과했습니다. 다음 날 다시 시도하십시오.
• description, 비즈니스 결과 설명.

curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "phone": "***",
  "id_card": "***"
}'

import requests

url = "https://api.xhuoapi.ai/v1/identity/phone/check-3e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "phone": "***",
    "id_card": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​

오류 처리

• 400 token_mismatched: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
• 400 api_not_implemented: 잘못된 요청, 누락되거나 잘못된 매개변수 때문일 수 있습니다.
• 401 invalid_token: 권한 없음, 잘못되었거나 누락된 인증 토큰입니다.
• 429 too_many_requests: 너무 많은 요청, 비율 제한을 초과했습니다.
• 500 api_error: 내부 서버 오류, 서버에서 문제가 발생했습니다.

​

오류 응답 예시

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "가져오기 실패"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​

결론