메인 콘텐츠로 건너뛰기
POST
curl

SMS에 브랜드 이름 표시하기

SMS 코드에는 Business Console에서 설정한 애플리케이션의 SMS 발신자 이름이 추가 요금 없이 포함됩니다:
123456은 Acme Bank의 인증 코드입니다
코드 하나에 다른 이름을 표시하려면 options.sms_sender_name을 전달하십시오. 이 값은 1자 이상 30자 이하이어야 하며, 문자, 숫자, 공백, ’ & - ! 만 사용할 수 있고 숫자만으로 구성할 수는 없습니다:
이 규칙을 벗어난 이름은 400 응답을 반환하며, 코드는 전송되지 않습니다. WhatsApp 코드는 고정된 메시지를 사용하므로 브랜드가 적용되지 않습니다. 비즈니스 이름으로 WhatsApp 코드를 전송하려면 Business Console에서 자체 WhatsApp Business 번호를 연결하십시오. 자세한 내용은 자체 번호로 WhatsApp 코드 보내기를 참조하십시오. 코드에 적용되는 이름과 새 이름의 일일 한도는 브랜드가 적용된 인증 메시지를 참조하십시오.

제공업체 장애 처리하기

전화 제공업체를 일시적으로 사용할 수 없으면 이 endpoint는 502와 안정적인 기계 판독용 코드를 반환합니다:
이 응답은 재시도 가능한 것으로 처리하십시오. 짧은 백오프를 적용한 후 재시도하고, 사용자에게 유효한 전화번호나 코드를 변경하도록 요구하는 대신 일시적인 서비스 장애 메시지를 표시하십시오.

인증

x-api-key
string
header
필수

Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본 키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며 특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나 만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된 IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를 벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write 권한이 없는 키는 세션 링크와 token을 null로 수신합니다. https://docs.didit.me/console/api-keys 를 참고하십시오.

본문

application/json
phone_number
string
필수

E.164 형식의 수취인 전화번호입니다. 앞자리에 +와 국가 코드가 포함됩니다(예: +14155552671). 번호는 검증 후 E.164 형식으로 정규화되며, 구문 분석할 수 없거나 유효하지 않은 번호는 phone_number 필드 오류와 함께 400을 반환합니다.

Maximum string length: 20
예시:

"+14155552671"

options
object

OTP 전송 옵션입니다. 모든 필드는 선택 사항입니다.

signals
object

최종 사용자에 대한 선택적 기기 및 네트워크 신호로, 어뷰징 또는 자동화된 트래픽 감지를 개선하기 위해 사기 방지 계층으로 전달됩니다. 모든 필드는 선택 사항입니다.

vendor_data
string

세션에 유지되고 전송 응답, 일치 확인 응답, webhook 및 Business Console에 그대로 반환되는 선택적 호출자 제어 식별자(내부 사용자 ID, 이메일, UUID 등)입니다. Didit의 request_id를 사용자 레코드와 연결하는 데 사용하십시오.

metadata
object | null

세션에 유지되고 전송 응답, 일치 확인 응답, webhook 및 Business Console에 다시 반환되는 선택적 자유 형식 JSON 객체입니다.

응답

전송이 확인되었습니다. status를 확인하십시오. Success 및 Retry는 코드가 발송 중임을 의미하며, Blocked는 사기 방지 계층에서 거부되어 인증이 이미 Declined로 완료되었음을 의미합니다. request_id는 유지되는 세션 ID입니다(Retry 시 동일한 ID).

request_id
string<uuid>

인증의 세션 id입니다. Retry 전송은 최초 전송과 동일한 request_id를 반환합니다. 이 id는 Business Console에 표시되며, 완료된 POST /v3/phone/check/에 의해 다시 반환되고, GET /v3/session/{sessionId}/decision/에 전달할 수 있습니다.

status
enum<string>

Success — 새 인증에 OTP가 전송되었습니다. Retry — 이전 전송으로 생성된 대기 중인 인증에 OTP가 재전송되었습니다. Blocked — 사기 방지 계층에서 전송을 거부했습니다. 인증은 즉시 Declined 상태로 완료 처리되며 요금은 청구되지 않습니다.

사용 가능한 옵션:
Success,
Retry,
Blocked
reason
string | null

발송이 Blocked된 이유입니다(예: repeated_attempts, suspicious, spam). Success 및 Retry에서는 null입니다.

vendor_data
string | null

세션에 저장된 vendor_data의 에코 값입니다(첫 전송 기준).

metadata
object | null

세션에 저장된 metadata의 에코 값입니다(첫 전송 기준).

마지막 수정일 2026년 11월 7일